From 0cd47929d4f7299234f2c40887eb03e43ebb0f74 Mon Sep 17 00:00:00 2001
From: "Eliel C. Sardanons" <eliels@gmail.com>
Date: Wed, 5 Nov 2008 01:44:04 +0000
Subject: [PATCH] - 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
---
apps/app_forkcdr.c | 2 +-
res/res_indications.c | 47 ++++++++++++++++++++++++++++++++++---------
2 files changed, 38 insertions(+), 11 deletions(-)
diff --git a/apps/app_forkcdr.c b/apps/app_forkcdr.c
index d48b6b50ba..a2ad1fe0f7 100644
--- a/apps/app_forkcdr.c
+++ b/apps/app_forkcdr.c
@@ -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
diff --git a/res/res_indications.c b/res/res_indications.c
index 7f185f3199..836abffc3e 100644
--- a/res/res_indications.c
+++ b/res/res_indications.c
@@ -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;
}
--
GitLab