changeset 26750:f916afb91566

Fixing warnings from `make docs` and stuff
author Paul Aurich <paul@darkrain42.org>
date Thu, 12 Mar 2009 03:52:54 +0000
parents 85bb3539d302
children b1c8ffbd48f9
files libpurple/xmlnode.h
diffstat 1 files changed, 7 insertions(+), 4 deletions(-) [+]
line wrap: on
line diff
--- a/libpurple/xmlnode.h	Wed Mar 11 04:39:56 2009 +0000
+++ b/libpurple/xmlnode.h	Thu Mar 12 03:52:54 2009 +0000
@@ -304,11 +304,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
  */