[Xen-devel] [PATCH] Add doc-comment to get_domain_by_id

[Mats Petersson <mats.petersson@xxxxxxxxxx>]

# HG changeset patch
# User Mats Petersson <mats.petersson@xxxxxxxxxx>
# Date 1358516011 0
# Node ID 9662deb217d7869d35dce5587ae8a1b45296b3a0
# Parent  126ce5f1855ba21ae24fc1c0981e5c05a3245bad
Add doc-comment to get_domain_by_id

diff --git a/xen/common/domain.c b/xen/common/domain.c
--- a/xen/common/domain.c
+++ b/xen/common/domain.c
@@ -373,7 +373,16 @@
     free_cpumask_var(cpumask);
 }
 
-
+/**
+ * This function finds a domain from a domain id. The domain's
+ * reference count is incremented as part of this function.
+ * The caller must call put_domain to un-reference the domain.
+ *
+ * @param dom       Domain ID of the domain to be found.
+ *
+ * @return         On success the pointer to a struct domain.
+ *                 On failure, return NULL.
+ */
 struct domain *get_domain_by_id(domid_t dom)
 {
     struct domain *d;

_______________________________________________
Xen-devel mailing list
Xen-devel@xxxxxxxxxxxxx
http://lists.xen.org/xen-devel