virXMLNodeGetSubelementList: Document return value semantics

The returned value is always non-NULL. Callers need to check the length
of the returned array instead.

Signed-off-by: Peter Krempa <pkrempa@redhat.com>
Reviewed-by: Ján Tomko <jtomko@redhat.com>

diff --git a/src/util/virxml.c b/src/util/virxml.c
index 06e698cdf8215c87c83ce87a511a18c880a4c89c..ad967a2564ecf37980a5c59559d2ee3dd740fe08 100644 (file)
--- a/src/util/virxml.c
+++ b/src/util/virxml.c
@@ -909,6 +909,8 @@ virXMLNodeGetSubelement(xmlNodePtr node,
  * Find and return a sub-elements node of @node named @name in a GPtrArray
  * populated with the xmlNodePtr objects. Caller is responsible for freeing the
  * array but not the contained xmlNode objects.
+ *
+ * Note: The returned GPtrArray is non-NULL even if @node doesn't contain such sub-elements
  */
 GPtrArray *
 virXMLNodeGetSubelementList(xmlNodePtr node,