From: Michal Privoznik <mprivozn@redhat.com>
Date: Fri, 6 Sep 2019 11:50:39 +0000 (+0200)
Subject: virdomainobjlist: Document virDomainObjListForEach()
X-Git-Url: http://xenbits.xensource.com/gitweb?a=commitdiff_plain;h=56f024f457b16219d512810ab1861c6c4482b516;p=libvirt.git

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 d640da6205..11fd68745b 100644
--- 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,