[Gaim-commits] SF.net SVN: gaim: [16730] trunk/src/xmlnode.h

[<dat...@us...>]

Revision: 16730
Author:   datallah
Date:     2006-08-12 19:18:28 -0700 (Sat, 12 Aug 2006)
ViewCVS:  http://svn.sourceforge.net/gaim/?rev=16730&view=rev

Log Message:
-----------
Fix the documentation to indicate that the result of xmlnode_get_data() needs to be g_free'd

Modified Paths:
--------------
    trunk/src/xmlnode.h
Modified: trunk/src/xmlnode.h
===================================================================
--- trunk/src/xmlnode.h	2006-08-12 22:18:28 UTC (rev 16729)
+++ trunk/src/xmlnode.h	2006-08-13 02:18:28 UTC (rev 16730)
@@ -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);
 


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.