virdomainobjlist: Document virDomainObjListForEach()

Signed-off-by: Michal Privoznik <mprivozn@redhat.com>
Reviewed-by: Ján Tomko <jtomko@redhat.com>

diff --git a/src/conf/virdomainobjlist.c b/src/conf/virdomainobjlist.c
index d640da6205dde422f1eb748fcf77fbf451abbfd7..11fd68745b0bc557867165d5097bac01da0d8220 100644 (file)
--- a/src/conf/virdomainobjlist.c
+++ b/src/conf/virdomainobjlist.c
@@ -815,6 +815,19 @@ virDomainObjListHelper(void *payload,
 }
 
 
+/**
+ * virDomainObjListForEach:
+ * @doms: Pointer to the domain object list
+ * @callback: callback to run over each domain on the list
+ * @opaque: opaque data to pass to @callback
+ *
+ * For every domain on the list (@doms) run @callback on it. If
+ * @callback fails (i.e. returns a negative value), the iteration
+ * carries still on until all domains are visited.
+ *
+ * Returns: 0 on success,
+ *         -1 otherwise.
+ */
 int
 virDomainObjListForEach(virDomainObjListPtr doms,
                         virDomainObjListIterator callback,