[asterisk-commits] eliel: branch group/appdocsxml r144003 - in /team/group/appdocsxml: include/a...

[SVN commits to the Asterisk project]

Author: eliel
Date: Tue Sep 23 10:04:06 2008
New Revision: 144003

URL: http://svn.digium.com/view/asterisk?view=rev&rev=144003
Log:
More documentation.


Modified:
    team/group/appdocsxml/include/asterisk/xml.h
    team/group/appdocsxml/main/pbx.c

Modified: team/group/appdocsxml/include/asterisk/xml.h
URL: http://svn.digium.com/view/asterisk/team/group/appdocsxml/include/asterisk/xml.h?view=diff&rev=144003&r1=144002&r2=144003
==============================================================================
--- team/group/appdocsxml/include/asterisk/xml.h (original)
+++ team/group/appdocsxml/include/asterisk/xml.h Tue Sep 23 10:04:06 2008
@@ -1,7 +1,7 @@
 /*
  * Asterisk -- An open source telephony toolkit.
  *
- * Copyright (C) 2008, Eliel C. Sardanons <eliels at gmail.com>
+ * Copyright (C) 2008, Eliel C. Sardanons (LU1ALY) <eliels at gmail.com>
  *
  * See http://www.asterisk.org for more information about
  * the Asterisk project. Please do not directly contact

Modified: team/group/appdocsxml/main/pbx.c
URL: http://svn.digium.com/view/asterisk/team/group/appdocsxml/main/pbx.c?view=diff&rev=144003&r1=144002&r2=144003
==============================================================================
--- team/group/appdocsxml/main/pbx.c (original)
+++ team/group/appdocsxml/main/pbx.c Tue Sep 23 10:04:06 2008
@@ -3032,6 +3032,8 @@
 /*! \internal
  *  \brief Colorize the xmldoc output.
  *  \param bwinput Not colorized input.
+ *  \param base_fg Initial foreground color.
+ *  \param base_bg Initial background color.
  *  \retval NULL on error.
  *  \retval New malloced buffer colorized.
  */
@@ -3254,6 +3256,7 @@
  *  \param rootnode A pointer to the ast_xml root node.
  *  \param rootname Name of the application, function, option, etc. to build the syntax.
  *  \param childname The name of each parameter node.
+ *  \param printparenthesis Boolean if we must print parenthesis if not parameters are found in the rootnode.
  *  \retval NULL on error.
  *  \retval An ast_malloc'ed string with the syntax generated. */
 static char *xmldoc_build_syntax(ast_xml_node *rootnode, const char *rootname, const char *childname, int printparenthesis)
@@ -3557,7 +3560,7 @@
  *  \param tabs put tabs before printing the node content.
  *  \param posttabs put posttabs after printing node content.
  *  \param len current buffer len (will be changed if data is appended to this buffer).
- *  \param buffer 
+ *  \param buffer Output buffer, the special tags will be appended here. 
  *  \retval 0 if no special element is parsed.
  *  \retval 1 if a special element is parsed.
  */
@@ -3797,7 +3800,7 @@
  *  \param buffer The output buffer.
  *  \param len The buffer length, (it will be changed if data is appended to buffer).
  *  \param fixnode An ast_xml pointer to the <option> node.
- *  \retval 0 if not option node is parsed.
+ *  \retval 0 if no option node is parsed.
  *  \retval 1 if an option node is parsed.
  */
 static int xmldoc_parse_option(char **buffer, int *len, ast_xml_node *fixnode)
@@ -4034,6 +4037,7 @@
  *  \param type Type of element (application, function, ...).
  *  \param name Name of element (Dial, Echo, Playback, ...).
  *  \param var Name of field to return (synopsis, description, etc).
+ *  \param raw Field only contains text, no other elements inside it. 
  *  \retval NULL On error.
  *  \retval Field text content on success.
  */
@@ -5838,7 +5842,10 @@
 
 #ifdef XML_DOCUMENTATION
 
-/*! \brief Load XML Document into buffer for parsing into a list */
+/*! \brief Load XML Document into buffer for parsing into a list.
+ *  \retval 1 on error.
+ *  \retval 0 on success.
+ */
 static int ast_load_documentation(void) 
 {
 	ast_xml_node *root_node;