Mercurial > pidgin.yaz
changeset 14100:85144ba7d726
[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>
| author | Daniel Atallah <daniel.atallah@gmail.com> |
|---|---|
| date | Sun, 13 Aug 2006 02:18:28 +0000 |
| parents | 7b030f6ed1c3 |
| children | a63358a0093e |
| files | src/xmlnode.h |
| diffstat | 1 files changed, 8 insertions(+), 7 deletions(-) [+] |
line wrap: on
line diff
--- 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);