Changeset 5697 for pjproject/trunk/pjlib-util/include/pjlib-util/xml.h

Timestamp:

Nov 17, 2017 4:07:43 AM (6 years ago)

Author:

ming

Message:

Re #2063: Add more doc in other parts of the library

File:

• pjproject/trunk/pjlib-util/include/pjlib-util/xml.h (modified) (1 diff)

pjproject/trunk/pjlib-util/include/pjlib-util/xml.h

@@ -74 +74 @@
  * be included in the resulted XML node tree.
  *
+ * Note that the XML message input buffer MUST be NULL terminated and have
+ * length at least len+1 (len MUST NOT include the NULL terminator).
+ *
  * @param pool      Pool to allocate memory from.
- * @param msg       The XML message to parse.
- * @param len       The length of the message.
+ * @param msg       The XML message to parse, MUST be NULL terminated.
+ * @param len       The length of the message, not including NULL terminator.
  *
  * @return          XML root node, or NULL if the XML document can not be parsed.