diff options
| author | Russell Bryant <russell@russellbryant.com> | 2008-11-01 21:10:07 +0000 |
|---|---|---|
| committer | Russell Bryant <russell@russellbryant.com> | 2008-11-01 21:10:07 +0000 |
| commit | 5b168ee34babe562be856ec8f1dd14c0abd7c1a5 (patch) | |
| tree | 9c836ac808552d20be6bd2baa3a3c29f642eda53 /apps/app_dahdiras.c | |
| parent | 1fef0f63bbbde9530837995c8790b839f73b74e7 (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: https://origsvn.digium.com/svn/asterisk/trunk@153365 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'apps/app_dahdiras.c')
| -rw-r--r-- | apps/app_dahdiras.c | 31 |
1 files changed, 21 insertions, 10 deletions
diff --git a/apps/app_dahdiras.c b/apps/app_dahdiras.c index 1671f8bdd..879868ea5 100644 --- a/apps/app_dahdiras.c +++ b/apps/app_dahdiras.c @@ -52,17 +52,28 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") #include "asterisk/module.h" #include "asterisk/app.h" -static char *app = "DAHDIRAS"; - -static char *synopsis = "Executes DAHDI ISDN RAS application"; +/*** DOCUMENTATION + <application name="DAHDIRAS" language="en_US"> + <synopsis> + Executes DAHDI ISDN RAS application. + </synopsis> + <syntax> + <parameter name="args" required="true"> + <para>A list of parameters to pass to the pppd daemon, + separeted by <literal>,</literal> characters.</para> + </parameter> + </syntax> + <description> + <para>Executes a RAS server using pppd on the given channel. + The channel must be a clear channel (i.e. PRI source) and a DAHDI + channel to be able to use this function (No modem emulation is included).</para> + <para>Your pppd must be patched to be DAHDI aware.</para> + </description> + </application> -static char *descrip = -" DAHDIRAS(args): Executes a RAS server using pppd on the given channel.\n" -"The channel must be a clear channel (i.e. PRI source) and a DAHDI\n" -"channel to be able to use this function (No modem emulation is included).\n" -"Your pppd must be patched to be DAHDI aware. Arguments should be\n" -"separated by , characters.\n"; + ***/ +static char *app = "DAHDIRAS"; #define PPP_MAX_ARGS 32 #define PPP_EXEC "/usr/sbin/pppd" @@ -218,7 +229,7 @@ static int unload_module(void) static int load_module(void) { - return ((ast_register_application(app, dahdiras_exec, synopsis, descrip)) ? AST_MODULE_LOAD_FAILURE : AST_MODULE_LOAD_SUCCESS); + return ((ast_register_application_xml(app, dahdiras_exec)) ? AST_MODULE_LOAD_FAILURE : AST_MODULE_LOAD_SUCCESS); } AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "DAHDI ISDN Remote Access Server"); |