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

[libvirt] [PATCH] Clarify documentation on possible return values in case of errors



Signed-off-by: Claudio Bley <cbley av-test de>
---
 src/libvirt.c |   10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

diff --git a/src/libvirt.c b/src/libvirt.c
index ffd4f8e..73972f2 100644
--- a/src/libvirt.c
+++ b/src/libvirt.c
@@ -14502,8 +14502,8 @@ virNodeDeviceGetName(virNodeDevicePtr dev)
  *
  * Accessor for the parent of the device
  *
- * Returns the name of the device's parent, or NULL if the
- * device has no parent.
+ * Returns the name of the device's parent, or NULL if an
+ * error occurred or when the device has no parent.
  */
 const char *
 virNodeDeviceGetParent(virNodeDevicePtr dev)
@@ -14537,7 +14537,8 @@ virNodeDeviceGetParent(virNodeDevicePtr dev)
  *
  * Accessor for the number of capabilities supported by the device.
  *
- * Returns the number of capabilities supported by the device.
+ * Returns the number of capabilities supported by the device or -1
+ * in case of error.
  */
 int
 virNodeDeviceNumOfCaps(virNodeDevicePtr dev)
@@ -14576,7 +14577,8 @@ error:
  *
  * Lists the names of the capabilities supported by the device.
  *
- * Returns the number of capability names listed in @names.
+ * Returns the number of capability names listed in @names or -1
+ * in case of error.
  */
 int
 virNodeDeviceListCaps(virNodeDevicePtr dev,
-- 
1.7.9.5


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