aboutsummaryrefslogtreecommitdiffstats
path: root/apps/app_dahdibarge.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 /apps/app_dahdibarge.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 'apps/app_dahdibarge.c')
-rw-r--r--apps/app_dahdibarge.c29
1 files changed, 19 insertions, 10 deletions
diff --git a/apps/app_dahdibarge.c b/apps/app_dahdibarge.c
index f16b4dea6..cfa445acc 100644
--- a/apps/app_dahdibarge.c
+++ b/apps/app_dahdibarge.c
@@ -52,17 +52,26 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
#include "asterisk/say.h"
#include "asterisk/utils.h"
+/*** DOCUMENTATION
+ <application name="DAHDIBarge" language="en_US">
+ <synopsis>
+ Barge in (monitor) DAHDI channel.
+ </synopsis>
+ <syntax>
+ <parameter name="channel">
+ <para>Channel to barge.</para>
+ </parameter>
+ </syntax>
+ <description>
+ <para>Barges in on a specified DAHDI <replaceable>channel</replaceable> or prompts
+ if one is not specified. Returns <literal>-1</literal> when caller user hangs
+ up and is independent of the state of the channel being monitored.
+ </para>
+ </description>
+ </application>
+ ***/
static char *app = "DAHDIBarge";
-static char *synopsis = "Barge in (monitor) DAHDI channel";
-
-static char *descrip =
-" DAHDIBarge([channel]): Barges in on a specified DAHDI\n"
-"channel or prompts if one is not specified. Returns\n"
-"-1 when caller user hangs up and is independent of the\n"
-"state of the channel being monitored.";
-
-
#define CONF_SIZE 160
static int careful_write(int fd, unsigned char *data, int len)
@@ -293,7 +302,7 @@ static int unload_module(void)
static int load_module(void)
{
- return ((ast_register_application(app, conf_exec, synopsis, descrip)) ? AST_MODULE_LOAD_FAILURE : AST_MODULE_LOAD_SUCCESS);
+ return ((ast_register_application_xml(app, conf_exec)) ? AST_MODULE_LOAD_FAILURE : AST_MODULE_LOAD_SUCCESS);
}
AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Barge in on DAHDI channel application");