libpurple/xmlnode.h

branch
cpw.darkrain42.docs
changeset 26831
bdddc4158544
parent 26646
ec5cf90362ec
parent 26556
4e09891c129f
child 27345
37d67bee50c2
--- a/libpurple/xmlnode.h	Sun Apr 19 15:35:28 2009 +0000
+++ b/libpurple/xmlnode.h	Mon Apr 20 00:10:51 2009 +0000
@@ -335,11 +335,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
  */

mercurial