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 /apps/app_senddtmf.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 'apps/app_senddtmf.c')
-rw-r--r-- | apps/app_senddtmf.c | 35 |
1 files changed, 23 insertions, 12 deletions
diff --git a/apps/app_senddtmf.c b/apps/app_senddtmf.c index 9863ce012..bd92230bd 100644 --- a/apps/app_senddtmf.c +++ b/apps/app_senddtmf.c @@ -35,19 +35,30 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") #include "asterisk/manager.h" #include "asterisk/channel.h" +/*** DOCUMENTATION + <application name="SendDTMF" language="en_US"> + <synopsis> + Sends arbitrary DTMF digits + </synopsis> + <syntax> + <parameter name="digits" required="true"> + <para>List of digits 0-9,*#,abcd</para> + </parameter> + <parameter name="timeout_ms" required="false"> + <para>Amount of time to wait in ms between tones. (defaults to .25s)</para> + </parameter> + <parameter name="duration_ms" required="false"> + <para>Duration of each digit</para> + </parameter> + </syntax> + <description> + <para>DTMF digits sent to a channel with half second pause</para> + <para>It will pass all digits or terminate if it encounters an error.</para> + </description> + </application> + ***/ static char *app = "SendDTMF"; -static char *synopsis = "Sends arbitrary DTMF digits"; - -static char *descrip = -" SendDTMF(digits[,[timeout_ms][,duration_ms]]): Sends DTMF digits on a channel. \n" -" Accepted digits: 0-9, *#abcd, (default .25s pause between digits)\n" -" The application will either pass the assigned digits or terminate if it\n" -" encounters an error.\n" -" Optional Params: \n" -" timeout_ms: pause between digits.\n" -" duration_ms: duration of each digit.\n"; - static int senddtmf_exec(struct ast_channel *chan, void *vdata) { int res = 0; @@ -121,7 +132,7 @@ static int load_module(void) int res; res = ast_manager_register2( "PlayDTMF", EVENT_FLAG_CALL, manager_play_dtmf, "Play DTMF signal on a specific channel.", mandescr_playdtmf ); - res |= ast_register_application(app, senddtmf_exec, synopsis, descrip); + res |= ast_register_application_xml(app, senddtmf_exec); return res; } |