Skip to content
Snippets Groups Projects
Commit 0cd47929 authored by Eliel C. Sardanons's avatar Eliel C. Sardanons
Browse files

- Add PlayTones() and StopPlayTones() applications XML documentation.

- Fix a dot that was outside of the <para> in the ForkCDR() XML documentation.


git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@154467 65c4cc65-6c06-0410-ace0-fbb531ad65f3
parent 086a52d9
No related branches found
No related tags found
No related merge requests found
......@@ -71,7 +71,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
</option>
<option name="s(name=val)">
<para>Set the CDR var <replaceable>name</replaceable> in the original CDR,
with value <replaceable>val</replaceable></para>.
with value <replaceable>val</replaceable>.</para>
</option>
<option name="T">
<para>Mark the original CDR with a DONT_TOUCH flag. setvar, answer, and end
......
......@@ -42,17 +42,44 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
#include "asterisk/indications.h"
#include "asterisk/utils.h"
/*** DOCUMENTATION
<application name="PlayTones" language="en_US">
<synopsis>
Play a tone list.
</synopsis>
<syntax>
<parameter name="arg" required="true">
<para>Arg is either the tone name defined in the <filename>indications.conf</filename>
configuration file, or a directly specified list of frequencies and durations.</para>
</parameter>
</syntax>
<description>
<para>Plays a tone list. Execution will continue with the next step immediately,
while the tones continue to play.</para>
<para>See the sample <filename>indications.conf</filename> for a description of the
specification of a tonelist.</para>
</description>
<see-also>
<ref type="application">StopPlayTones</ref>
</see-also>
</application>
<application name="StopPlayTones" language="en_US">
<synopsis>
Stop playing a tone list.
</synopsis>
<syntax />
<description>
<para>Stop playing a tone list, initiated by PlayTones().</para>
</description>
<see-also>
<ref type="application">PlayTones</ref>
</see-also>
</application>
***/
/* Globals */
static const char config[] = "indications.conf";
char *playtones_desc=
" PlayTones(arg): Plays a tone list. Execution will continue with the next step immediately,\n"
"while the tones continue to play.\n"
"Arg is either the tone name defined in the indications.conf configuration file, or a directly\n"
"specified list of frequencies and durations.\n"
"See the sample indications.conf for a description of the specification of a tonelist.\n\n"
"Use the StopPlayTones application to stop the tones playing. \n";
/*
* Implementation of functions provided by this module
*/
......@@ -423,8 +450,8 @@ static int load_module(void)
if (ind_load_module(0))
return AST_MODULE_LOAD_DECLINE;
ast_cli_register_multiple(cli_indications, sizeof(cli_indications) / sizeof(struct ast_cli_entry));
ast_register_application("PlayTones", handle_playtones, "Play a tone list", playtones_desc);
ast_register_application("StopPlayTones", handle_stopplaytones, "Stop playing a tone list"," StopPlayTones(): Stop playing a tone list");
ast_register_application_xml("PlayTones", handle_playtones);
ast_register_application_xml("StopPlayTones", handle_stopplaytones);
return AST_MODULE_LOAD_SUCCESS;
}
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment