[libvirt] [PATCH] util: Add docs for virXMLProp string

To avoid confusion about usage of this function explicitly document that this function returns copy of the attribute string. --- src/util/virxml.c | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/src/util/virxml.c b/src/util/virxml.c index 74f8beb..aa55a33 100644 --- a/src/util/virxml.c +++ b/src/util/virxml.c @@ -468,6 +468,16 @@ virXPathLongLong(const char *xpath, return ret; } +/** + * virXMLPropString: + * @node: XML dom node pointer + * @name: Name of the property (attribute) to get + * + * Convenience function to return copy of an attribute value of a XML node. + * + * Returns the property (attribute) value as string or NULL in case of failure. + * The caller is responsible for freeing the returned buffer. + */ char * virXMLPropString(xmlNodePtr node, const char *name) -- 1.8.1.1