[svn-commits] eliel: branch group/appdocsxml r145332 - /team/group/appdocsxml/funcs/

[SVN commits to the Digium repositories]

Author: eliel
Date: Wed Oct  1 07:55:22 2008
New Revision: 145332

URL: http://svn.digium.com/view/asterisk?view=rev&rev=145332
Log:
Introduce AST_CONFIG() function XML documentation.

Modified:
    team/group/appdocsxml/funcs/func_config.c

Modified: team/group/appdocsxml/funcs/func_config.c
URL: http://svn.digium.com/view/asterisk/team/group/appdocsxml/funcs/func_config.c?view=diff&rev=145332&r1=145331&r2=145332
==============================================================================
--- team/group/appdocsxml/funcs/func_config.c (original)
+++ team/group/appdocsxml/funcs/func_config.c Wed Oct  1 07:55:22 2008
@@ -35,6 +35,23 @@
 #include "asterisk/channel.h"
 #include "asterisk/pbx.h"
 #include "asterisk/app.h"
+
+/*** DOCUMENTATION
+	<function name="AST_CONFIG" language="en_US">
+		<synopsis>
+			Retrieve a variable from a configuration file.
+		</synopsis>
+		<syntax>
+			<parameter name="config_file" required="true" />
+			<parameter name="category" required="true" />
+			<parameter name="variable_name" required="true" />
+		</syntax>
+		<description>
+			<para>This function reads a variable from an Asterisk configuration file.</para>
+		</description>
+	</function>
+
+***/
 
 struct config_item {
 	AST_RWLIST_ENTRY(config_item) entry;
@@ -160,11 +177,6 @@
 
 static struct ast_custom_function config_function = {
 	.name = "AST_CONFIG",
-	.syntax = "AST_CONFIG(config_file,category,variable_name)",
-	.synopsis = "Retrieve a variable from a configuration file",
-	.desc = 
-	"   This function reads a variable from an Asterisk configuration file.\n"
-	"",
 	.read = config_function_read,
 };