[asterisk-commits] eliel: branch group/appdocsxml r136400 - /team/group/appdocsxml/main/pbx.c

[SVN commits to the Asterisk project]

Author: eliel
Date: Thu Aug  7 07:46:18 2008
New Revision: 136400

URL: http://svn.digium.com/view/asterisk?view=rev&rev=136400
Log:
Added ast_xml_doc_get_field() documentation.


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=136400&r1=136399&r2=136400
==============================================================================
--- team/group/appdocsxml/main/pbx.c (original)
+++ team/group/appdocsxml/main/pbx.c Thu Aug  7 07:46:18 2008
@@ -2889,7 +2889,13 @@
 	return ret;
 }
 
-/*! \brief TODO: complete doc. */
+/*! \brief Get the content of a field (synopsis, description, etc) from an asterisk document tree
+ *  \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).
+ *  \retval NULL On error.
+ *  \retval Field text content on success.
+ */
 static char *ast_xml_doc_get_field(const char *type, const char *name, const char *var)
 {
 	ast_xml_node *node, *ret = NULL;