# HG changeset patch
# User Daniel Atallah <daniel.atallah@gmail.com>
# Date 1155435508 0
# Node ID 85144ba7d726e67d317648b4c2dcf172ba4289f4
# Parent  7b030f6ed1c3f6cc29f6c849820b14974ef56673
[gaim-migrate @ 16730]
Fix the documentation to indicate that the result of xmlnode_get_data() needs to be g_free'd

committer: Tailor Script <tailor@pidgin.im>

diff -r 7b030f6ed1c3 -r 85144ba7d726 src/xmlnode.h
--- a/src/xmlnode.h	Sat Aug 12 22:16:23 2006 +0000
+++ b/src/xmlnode.h	Sun Aug 13 02:18:28 2006 +0000
@@ -31,7 +31,7 @@
 typedef enum _XMLNodeType
 {
 	XMLNODE_TYPE_TAG,		/**< Just a tag */
-	XMLNODE_TYPE_ATTRIB,	/**< Has attributes */
+	XMLNODE_TYPE_ATTRIB,		/**< Has attributes */
 	XMLNODE_TYPE_DATA		/**< Has data */
 } XMLNodeType;
 
@@ -40,13 +40,13 @@
  */
 typedef struct _xmlnode
 {
-	char *name;					/**< The name of the node. */
+	char *name;			/**< The name of the node. */
 #ifdef HAVE_LIBXML
-	char *namespace;                    /**< The namespace of the node */
+	char *namespace;		/**< The namespace of the node */
 #endif
-	XMLNodeType type;			/**< The type of the node. */
-	char *data;					/**< The data for the node. */
-	size_t data_sz;				/**< The size of the data. */
+	XMLNodeType type;		/**< The type of the node. */
+	char *data;			/**< The data for the node. */
+	size_t data_sz;			/**< The size of the data. */
 	struct _xmlnode *parent;	/**< The parent node or @c NULL.*/
 	struct _xmlnode *child;		/**< The child node or @c NULL.*/
 	struct _xmlnode *lastchild;	/**< The last child node or @c NULL.*/
@@ -125,7 +125,8 @@
  *
  * @param node The node to get data from.
  *
- * @return The data from the node.
+ * @return The data from the node.  You must g_free
+ *         this string when finished using it.
  */
 char *xmlnode_get_data(xmlnode *node);