aboutsummaryrefslogtreecommitdiffstats
path: root/funcs/func_config.c
diff options
context:
space:
mode:
authorrussell <russell@f38db490-d61c-443f-a65b-d21fe96a405b>2008-11-01 21:10:07 +0000
committerrussell <russell@f38db490-d61c-443f-a65b-d21fe96a405b>2008-11-01 21:10:07 +0000
commitb1f91b97d2085cc845d0f57bd9907de50c995105 (patch)
tree9c836ac808552d20be6bd2baa3a3c29f642eda53 /funcs/func_config.c
parentc5d084051f21e943fcbcc347fc80b166885f298d (diff)
Merge changes from team/group/appdocsxml
This commit introduces the first phase of an effort to manage documentation of the interfaces in Asterisk in an XML format. Currently, a new format is available for applications and dialplan functions. A good number of conversions to the new format are also included. For more information, see the following message to asterisk-dev: http://lists.digium.com/pipermail/asterisk-dev/2008-October/034968.html git-svn-id: http://svn.digium.com/svn/asterisk/trunk@153365 f38db490-d61c-443f-a65b-d21fe96a405b
Diffstat (limited to 'funcs/func_config.c')
-rw-r--r--funcs/func_config.c22
1 files changed, 17 insertions, 5 deletions
diff --git a/funcs/func_config.c b/funcs/func_config.c
index 5669f3655..21d291c2e 100644
--- a/funcs/func_config.c
+++ b/funcs/func_config.c
@@ -36,6 +36,23 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
#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;
struct ast_config *cfg;
@@ -160,11 +177,6 @@ static int config_function_read(struct ast_channel *chan, const char *cmd, char
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,
};