diff options
| author | russell <russell@f38db490-d61c-443f-a65b-d21fe96a405b> | 2008-11-01 21:10:07 +0000 |
|---|---|---|
| committer | russell <russell@f38db490-d61c-443f-a65b-d21fe96a405b> | 2008-11-01 21:10:07 +0000 |
| commit | b1f91b97d2085cc845d0f57bd9907de50c995105 (patch) | |
| tree | 9c836ac808552d20be6bd2baa3a3c29f642eda53 /funcs/func_module.c | |
| parent | c5d084051f21e943fcbcc347fc80b166885f298d (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_module.c')
| -rw-r--r-- | funcs/func_module.c | 23 |
1 files changed, 18 insertions, 5 deletions
diff --git a/funcs/func_module.c b/funcs/func_module.c index 8b2326386..a7cf73164 100644 --- a/funcs/func_module.c +++ b/funcs/func_module.c @@ -28,6 +28,24 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") #include "asterisk/module.h" #include "asterisk/pbx.h" +/*** DOCUMENTATION + <function name="IFMODULE" language="en_US"> + <synopsis> + Checks if an Asterisk module is loaded in memory. + </synopsis> + <syntax> + <parameter name="modulename.so" required="true"> + <para>Module name complete with <literal>.so</literal></para> + </parameter> + </syntax> + <description> + <para>Checks if a module is loaded. Use the full module name + as shown by the list in <literal>module list</literal>. + Returns <literal>1</literal> if module exists in memory, otherwise <literal>0</literal></para> + </description> + </function> + ***/ + static int ifmodule_read(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len) { @@ -46,12 +64,7 @@ static int ifmodule_read(struct ast_channel *chan, const char *cmd, char *data, static struct ast_custom_function ifmodule_function = { .name = "IFMODULE", - .synopsis = "Checks if an Asterisk module is loaded in memory", - .syntax = "IFMODULE(<modulename.so>)", .read = ifmodule_read, - .desc = "Checks if a module is loaded. Use the full module name\n" - "as shown by the list in \"module list\". \n" - "Returns \"1\" if module exists in memory, otherwise \"0\".\n", }; |