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

[libvirt] [PATCH] docs: Make virConnectClose comply to apibuild.py expectations



apibuild.py expects a sentence that starts with "Returns"
describing the return value of a function.
---
 src/libvirt.c |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)

diff --git a/src/libvirt.c b/src/libvirt.c
index 63fe7ff..69e0ea8 100644
--- a/src/libvirt.c
+++ b/src/libvirt.c
@@ -1303,7 +1303,7 @@ error:
  * matching virConnectClose, and all other references will be released
  * after the corresponding operation completes.
  *
- * The return value is the number of remaining references on success
+ * Returns the number of remaining references on success
  * (positive implies that some other call still has a reference open,
  * 0 implies that no references remain and the connection is closed),
  * or -1 on failure.  It is possible for the last virConnectClose to
-- 
1.7.0.4


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