summaryrefslogtreecommitdiff
path: root/apps/app_morsecode.c
diff options
context:
space:
mode:
authorRussell Bryant <russell@russellbryant.com>2008-11-01 21:10:07 +0000
committerRussell Bryant <russell@russellbryant.com>2008-11-01 21:10:07 +0000
commit5b168ee34babe562be856ec8f1dd14c0abd7c1a5 (patch)
tree9c836ac808552d20be6bd2baa3a3c29f642eda53 /apps/app_morsecode.c
parent1fef0f63bbbde9530837995c8790b839f73b74e7 (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: https://origsvn.digium.com/svn/asterisk/trunk@153365 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'apps/app_morsecode.c')
-rw-r--r--apps/app_morsecode.c37
1 files changed, 26 insertions, 11 deletions
diff --git a/apps/app_morsecode.c b/apps/app_morsecode.c
index 455ee04c1..f9005296a 100644
--- a/apps/app_morsecode.c
+++ b/apps/app_morsecode.c
@@ -34,18 +34,33 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
#include "asterisk/module.h"
#include "asterisk/indications.h"
+/*** DOCUMENTATION
+ <application name="Morsecode" language="en_US">
+ <synopsis>
+ Plays morse code
+ </synopsis>
+ <syntax>
+ <parameter name="string" required="true">
+ <para>String to playback as morse code to channel</para>
+ </parameter>
+ </syntax>
+ <description>
+ <para>Plays the Morse code equivalent of the passed string.</para>
+
+ <para>This application uses the following variables:</para>
+ <variablelist>
+ <variable name="MORSEDITLEN">
+ <para>Use this value in (ms) for length of dit</para>
+ </variable>
+ <variable name="MORSETONE">
+ <para>The pitch of the tone in (Hz), default is 800</para>
+ </variable>
+ </variablelist>
+ </description>
+ </application>
+ ***/
static char *app_morsecode = "Morsecode";
-static char *morsecode_synopsis = "Plays morse code";
-
-static char *morsecode_descrip =
-" Morsecode(<string>):\n"
-"Plays the Morse code equivalent of the passed string. If the variable\n"
-"MORSEDITLEN is set, it will use that value for the length (in ms) of the dit\n"
-"(defaults to 80). Additionally, if MORSETONE is set, it will use that tone\n"
-"(in Hz). The tone default is 800.\n";
-
-
static char *morsecode[] = {
"", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", /* 0-15 */
"", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", /* 16-31 */
@@ -159,7 +174,7 @@ static int unload_module(void)
static int load_module(void)
{
- return ast_register_application(app_morsecode, morsecode_exec, morsecode_synopsis, morsecode_descrip);
+ return ast_register_application_xml(app_morsecode, morsecode_exec);
}
AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Morse code");