diff options
| author | Eliel C. Sardanons <eliels@gmail.com> | 2009-05-22 17:52:35 +0000 |
|---|---|---|
| committer | Eliel C. Sardanons <eliels@gmail.com> | 2009-05-22 17:52:35 +0000 |
| commit | 2c882626a0ebbfe6dfe9d89cb495765a218e978d (patch) | |
| tree | e1c6ca80d913c0e0aa3166a40d7b8e4461cd62d1 /apps/app_senddtmf.c | |
| parent | 3c7db3b7e84c8dbf1f561f8e37b23add5332d456 (diff) | |
Implement a new element in AstXML for AMI actions documentation.
A new xml element was created to manage the AMI actions documentation,
using AstXML.
To register a manager action using XML documentation it is now possible
using ast_manager_register_xml().
The CLI command 'manager show command' can be used to show the parsed
documentation.
Example manager xml documentation:
<manager name="ami action name" language="en_US">
<synopsis>
AMI action synopsis.
</synopsis>
<syntax>
<xi:include xpointer="xpointer(...)" /> <-- for ActionID
<parameter name="header1" required="true">
<para>Description</para>
</parameter>
...
</syntax>
<description>
<para>AMI action description</para>
</description>
<see-also>
...
</see-also>
</manager>
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@196308 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'apps/app_senddtmf.c')
| -rw-r--r-- | apps/app_senddtmf.c | 25 |
1 files changed, 18 insertions, 7 deletions
diff --git a/apps/app_senddtmf.c b/apps/app_senddtmf.c index 68f2d784f..395ae28c9 100644 --- a/apps/app_senddtmf.c +++ b/apps/app_senddtmf.c @@ -59,6 +59,23 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") <ref type="application">Read</ref> </see-also> </application> + <manager name="PlayDTMF" language="en_US"> + <synopsis> + Play DTMF signal on a specific channel. + </synopsis> + <syntax> + <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" /> + <parameter name="Channel" required="true"> + <para>Channel name to send digit to.</para> + </parameter> + <parameter name="Digit" required="true"> + <para>The DTMF digit to play.</para> + </parameter> + </syntax> + <description> + <para>Plays a dtmf digit on the specified channel.</para> + </description> + </manager> ***/ static char *app = "SendDTMF"; @@ -90,12 +107,6 @@ static int senddtmf_exec(struct ast_channel *chan, const char *vdata) return res; } -static const char mandescr_playdtmf[] = -"Description: Plays a dtmf digit on the specified channel.\n" -"Variables: (all are required)\n" -" Channel: Channel name to send digit to\n" -" Digit: The dtmf digit to play\n"; - static int manager_play_dtmf(struct mansession *s, const struct message *m) { const char *channel = astman_get_header(m, "Channel"); @@ -136,7 +147,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_manager_register_xml("PlayDTMF", EVENT_FLAG_CALL, manager_play_dtmf); res |= ast_register_application_xml(app, senddtmf_exec); return res; |