diff libpurple/xmlnode.h @ 26679:872d30754311

propagate from branch 'im.pidgin.pidgin' (head 1ae2b55502a0afd8f28918fc4726683c52e998e9) to branch 'im.pidgin.cpw.darkrain42.docs' (head 3dd6aa6f6c394f0be53f01c2decd3f15ff229ff5)
author Paul Aurich <paul@darkrain42.org>
date Mon, 20 Apr 2009 00:10:51 +0000
parents 4c1af7f30af8 7c3baa45c9c4
children 350f097019eb
line wrap: on
line diff
--- 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
  */