Clarify documentation on possible return values in case of errors

This commit is contained in:
Claudio Bley 2014-01-09 07:58:51 +01:00
parent f86e463040
commit c4dadf2393

View File

@ -14423,8 +14423,8 @@ virNodeDeviceGetName(virNodeDevicePtr dev)
* *
* Accessor for the parent of the device * Accessor for the parent of the device
* *
* Returns the name of the device's parent, or NULL if the * Returns the name of the device's parent, or NULL if an
* device has no parent. * error occurred or when the device has no parent.
*/ */
const char * const char *
virNodeDeviceGetParent(virNodeDevicePtr dev) virNodeDeviceGetParent(virNodeDevicePtr dev)
@ -14454,7 +14454,8 @@ virNodeDeviceGetParent(virNodeDevicePtr dev)
* *
* Accessor for the number of capabilities supported by the device. * 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 int
virNodeDeviceNumOfCaps(virNodeDevicePtr dev) virNodeDeviceNumOfCaps(virNodeDevicePtr dev)
@ -14489,7 +14490,8 @@ error:
* *
* Lists the names of the capabilities supported by the device. * 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 int
virNodeDeviceListCaps(virNodeDevicePtr dev, virNodeDeviceListCaps(virNodeDevicePtr dev,