[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]

[libvirt] [PATCH] lib: Fix function documentation for virConnectListDomains



Clarify the documentation of virConnectListDomains.
---
 src/libvirt.c |    4 ++--
 1 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/src/libvirt.c b/src/libvirt.c
index a55d823..6294196 100644
--- a/src/libvirt.c
+++ b/src/libvirt.c
@@ -1818,23 +1818,23 @@ error:
     virDispatchError(conn);
     return -1;
 }

 /**
  * virConnectListDomains:
  * @conn: pointer to the hypervisor connection
  * @ids: array to collect the list of IDs of active domains
  * @maxids: size of @ids
  *
- * Collect the list of active domains, and store their ID in @maxids
+ * Collect the list of active domains, and store their IDs in array @ids
  *
- * Returns the number of domain found or -1 in case of error
+ * Returns the number of domains found or -1 in case of error
  */
 int
 virConnectListDomains(virConnectPtr conn, int *ids, int maxids)
 {
     VIR_DEBUG("conn=%p, ids=%p, maxids=%d", conn, ids, maxids);

     virResetLastError();

     if (!VIR_IS_CONNECT(conn)) {
         virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
-- 
1.7.3.4


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]