[svn-commits] eliel: branch group/appdocsxml r153182 - /team/group/appdocsxml/main/pbx.c

[SVN commits to the Digium repositories]

Author: eliel
Date: Fri Oct 31 14:15:08 2008
New Revision: 153182

URL: http://svn.digium.com/view/asterisk?view=rev&rev=153182
Log:
Add more doxygen

Modified:
    team/group/appdocsxml/main/pbx.c

Modified: team/group/appdocsxml/main/pbx.c
URL: http://svn.digium.com/view/asterisk/team/group/appdocsxml/main/pbx.c?view=diff&rev=153182&r1=153181&r2=153182
==============================================================================
--- team/group/appdocsxml/main/pbx.c (original)
+++ team/group/appdocsxml/main/pbx.c Fri Oct 31 14:15:08 2008
@@ -4565,6 +4565,14 @@
 }
 #endif /* AST_XML_DOCS */
 
+/*! \internal
+ *  \brief Retrieve the XML documentation of a specified ast_custom_function,
+ *         and populate ast_custom_function string fields.
+ *  \param acf ast_custom_function structure with empty 'desc' and 'synopsis'
+ *             but with a function 'name'.
+ *  \retval -1 On error.
+ *  \retval 0 On succes.
+ */
 static int acf_retrieve_docs(struct ast_custom_function *acf)
 {
 #ifdef AST_XML_DOCS