Mercurial > pidgin

diff libpurple/xmlnode.h @ 26676:efbbd2e2b29e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
propagate from branch 'im.pidgin.pidgin' (head 81bb2e1582a2222b36e57c29ccb573dac27f2a44) to branch 'im.pidgin.cpw.darkrain42.docs' (head d46cce50156607d3683093354f47e17677c2283c)
author Paul Aurich <paul@darkrain42.org>
date Sat, 28 Mar 2009 18:59:23 +0000
parents 7c3baa45c9c4
children 872d30754311
line wrap: on
line diff
--- a/libpurple/xmlnode.h	Sat Mar 28 16:58:32 2009 +0000
+++ b/libpurple/xmlnode.h	Sat Mar 28 18:59:23 2009 +0000
@@ -324,11 +324,14 @@
  * root node of an XML document will parse the entire document
  * into a tree of nodes, and return the xmlnode of the root.
  *
- * @param str  The string of xml.
- * @param description  The description of the file being parsed
- * @process  The utility that is calling xmlnode_from_file
+ * @param dir  The directory where the file is located
+ * @param filename  The filename
+ * @param description  A description of the file being parsed. Displayed to
+ * 			the user if the file cannot be read.
+ * @param process  The subsystem that is calling xmlnode_from_file. Used as
+ * 			the category for debugging.
  *
- * @return The new node.
+ * @return The new node or NULL if an error occurred.
  *
  * @since 2.6.0
  */