[asterisk-commits] mvanbaak: branch group/appdocsxml r143130 - /team/group/appdocsxml/apps/
SVN commits to the Asterisk project
asterisk-commits at lists.digium.com
Mon Sep 15 12:22:51 CDT 2008
Author: mvanbaak
Date: Mon Sep 15 12:22:51 2008
New Revision: 143130
URL: http://svn.digium.com/view/asterisk?view=rev&rev=143130
Log:
Fix the xml for some applications.
passes xmllint validation now.
Modified:
team/group/appdocsxml/apps/app_dial.c
team/group/appdocsxml/apps/app_fax.c
team/group/appdocsxml/apps/app_morsecode.c
Modified: team/group/appdocsxml/apps/app_dial.c
URL: http://svn.digium.com/view/asterisk/team/group/appdocsxml/apps/app_dial.c?view=diff&rev=143130&r1=143129&r2=143130
==============================================================================
--- team/group/appdocsxml/apps/app_dial.c (original)
+++ team/group/appdocsxml/apps/app_dial.c Mon Sep 15 12:22:51 2008
@@ -440,7 +440,7 @@
extension exists in either the context defined in ${EXITCONTEXT} or the current
one, The call will jump to that extension immediately.
The <replaceable>dialargs</replaceable> are specified in the same format that arguments are provided
- to the Dial application.<para>
+ to the Dial application.</para>
</description>
</application>
***/
Modified: team/group/appdocsxml/apps/app_fax.c
URL: http://svn.digium.com/view/asterisk/team/group/appdocsxml/apps/app_fax.c?view=diff&rev=143130&r1=143129&r2=143130
==============================================================================
--- team/group/appdocsxml/apps/app_fax.c (original)
+++ team/group/appdocsxml/apps/app_fax.c Mon Sep 15 12:22:51 2008
@@ -45,155 +45,109 @@
<synopsis>
Send a Fax
</synopsis>
+ <syntax>
+ <parameter name="filename" required="true">
+ <para>Filename of TIFF file to fax</para>
+ </parameter>
+ <parameter name="a" required="false">
+ <para>Makes the application behave as the answering machine</para>
+ <para>(Default behavior is as calling machine)</para>
+ </parameter>
+ </syntax>
<description>
- Send a given TIFF file to the channel as a FAX.
+ <para>Send a given TIFF file to the channel as a FAX.</para>
+ <para>This application sets the following channel variables:</para>
+ <variablelist>
+ <variable name="LOCALSTATIONID">
+ <para>To identify itself to the remote end</para>
+ </variable>
+ <variable name="LOCALHEADERINFO">
+ <para>To generate a header line on each page</para>
+ </variable>
+ <variable name="FAXSTATUS">
+ <value name="SUCCESS"/>
+ <value name="FAILED"/>
+ </variable>
+ <variable name="FAXERROR">
+ <para>Cause of failure</para>
+ </variable>
+ <variable name="REMOTESTATIONID">
+ <para>The CSID of the remote side</para>
+ </variable>
+ <variable name="FAXPAGES">
+ <para>Number of pages sent</para>
+ </variable>
+ <variable name="FAXBITRATE">
+ <para>Transmission rate</para>
+ </variable>
+ <variable name="FAXRESOLUTION">
+ <para>Resolution of sent fax</para>
+ </variable>
+ </variablelist>
</description>
- <variable name="LOCALSTATIONID">
- To identify itself to the remote end
- </variable>
- <variable name="LOCALHEADERINFO">
- To generate a header line on each page
- </variable>
- <variable name="FAXSTATUS">
- <value name="SUCCESS"/>
- <value name="FAILED"/>
- </variable>
- <variable name="FAXERROR">
- Cause of failure
- </variable>
- <variable name="REMOTESTATIONID">
- The CSID of the remote side
- </variable>
- <variable name="FAXPAGES">
- Number of pages sent
- </variable>
- <variable name="FAXBITRATE">
- Transmission rate
- </variable>
- <variable name="FAXRESOLUTION">
- Resolution of sent fax
- </variable>
- <option name="filename" required="true">
- Filename of TIFF file to fax
- </option>
- <option name="a">
- Makes the application behave as the answering machine
- (Default behavior is as calling machine)
- </option>
<return>
<value name="0">Success</value>
<value name="1">Failure</value>
</return>
</application>
- ***/
-
-static char *app_sndfax_name = "SendFAX";
-static char *app_sndfax_synopsis = "Send a FAX";
-/*
-static char *app_sndfax_desc =
-" SendFAX(filename[|options]):\n"
-"Send a given TIFF file to the channel as a FAX.\n"
-"The option string may contain zero or more of the following characters:\n"
-" 'a' - makes the application behave as an answering machine\n"
-" The default behaviour is to behave as a calling machine.\n"
-"\n"
-"This application uses following variables:\n"
-" LOCALSTATIONID to identify itself to the remote end.\n"
-" LOCALHEADERINFO to generate a header line on each page.\n"
-"\n"
-"This application sets the following channel variables upon completion:\n"
-" FAXSTATUS - status of operation:\n"
-" SUCCESS | FAILED\n"
-" FAXERROR - Error when FAILED\n"
-" FAXMODE - Mode used:\n"
-" audio | T38\n"
-" REMOTESTATIONID - CSID of the remote side.\n"
-" FAXPAGES - number of pages sent.\n"
-" FAXBITRATE - transmition rate.\n"
-" FAXRESOLUTION - resolution.\n"
-"\n"
-"Returns -1 in case of user hang up or any channel error.\n"
-"Returns 0 on success.\n";
-*/
-
-/*** DOCUMENTATION
<application name="ReceiveFAX" language="en_US">
<synopsis>
Receive a Fax
</synopsis>
+ <syntax>
+ <parameter name="filename" required="true">
+ <para>Filename of TIFF file save incoming fax</para>
+ </parameter>
+ <parameter name="c" required="false">
+ <para>Makes the application behave as the calling machine</para>
+ <para>(Default behavior is as answering machine)</para>
+ </parameter>
+ </syntax>
<description>
- Receives a FAX from the channel into the given filename
- overwriting the file if it already exists.
- File created will be in TIFF format.
+ <para>Receives a FAX from the channel into the given filename
+ overwriting the file if it already exists.</para>
+ <para>File created will be in TIFF format.</para>
+
+ <para>This application sets the following channel variables:</para>
+ <variablelist>
+ <variable name="LOCALSTATIONID">
+ <para>To identify itself to the remote end</para>
+ </variable>
+ <variable name="LOCALHEADERINFO">
+ <para>To generate a header line on each page</para>
+ </variable>
+ <variable name="FAXSTATUS">
+ <value name="SUCCESS"/>
+ <value name="FAILED"/>
+ </variable>
+ <variable name="FAXERROR">
+ <para>Cause of failure</para>
+ </variable>
+ <variable name="REMOTESTATIONID">
+ <para>The CSID of the remote side</para>
+ </variable>
+ <variable name="FAXPAGES">
+ <para>Number of pages sent</para>
+ </variable>
+ <variable name="FAXBITRATE">
+ <para>Transmission rate</para>
+ </variable>
+ <variable name="FAXRESOLUTION">
+ <para>Resolution of sent fax</para>
+ </variable>
+ </variablelist>
</description>
- <variable name="LOCALSTATIONID">
- To identify itself to the remote end
- </variable>
- <variable name="LOCALHEADERINFO">
- To generate a header line on each page
- </variable>
- <variable name="FAXSTATUS">
- <value name="SUCCESS"/>
- <value name="FAILED"/>
- </variable>
- <variable name="FAXERROR">
- Cause of failure
- </variable>
- <variable name="REMOTESTATIONID">
- The CSID of the remote side
- </variable>
- <variable name="FAXPAGES">
- Number of pages sent
- </variable>
- <variable name="FAXBITRATE">
- Transmission rate
- </variable>
- <variable name="FAXRESOLUTION">
- Resolution of sent fax
- </variable>
- <option name="filename" required="true">
- Filename of TIFF file save incoming fax
- </option>
- <option name="c">
- Makes the application behave as the calling machine
- (Default behavior is as answering machine)
- </option>
<return>
<value name="0">Success</value>
<value name="-1">Failure if user hangup or channel error</value>
</return>
</application>
+
***/
+static char *app_sndfax_name = "SendFAX";
static char *app_rcvfax_name = "ReceiveFAX";
-static char *app_rcvfax_synopsis = "Receive a FAX";
-/*
-static char *app_rcvfax_desc =
-" ReceiveFAX(filename[|options]):\n"
-"Receives a fax from the channel into the given filename overwriting\n"
-"the file if it already exists. File created will have TIFF format.\n"
-"The option string may contain zero or more of the following characters:\n"
-" 'c' -- makes the application behave as a calling machine\n"
-" The default behaviour is to behave as an answering machine.\n"
-"\n"
-"This application uses following variables:\n"
-" LOCALSTATIONID to identify itself to the remote end.\n"
-" LOCALHEADERINFO to generate a header line on each page.\n"
-"\n"
-"This application sets the following channel variables upon completion:\n"
-" FAXSTATUS - status of operation:\n"
-" SUCCESS | FAILED\n"
-" FAXERROR - Error when FAILED\n"
-" FAXMODE - Mode used:\n"
-" audio | T38\n"
-" REMOTESTATIONID - CSID of the remote side.\n"
-" FAXPAGES - number of pages sent.\n"
-" FAXBITRATE - transmition rate.\n"
-" FAXRESOLUTION - resolution.\n"
-"\n"
-"Returns -1 in case of user hang up or any channel error.\n"
-"Returns 0 on success.\n";
-*/
+
#define MAX_SAMPLES 240
/* Watchdog. I have seen situations when remote fax disconnects (because of poor line
Modified: team/group/appdocsxml/apps/app_morsecode.c
URL: http://svn.digium.com/view/asterisk/team/group/appdocsxml/apps/app_morsecode.c?view=diff&rev=143130&r1=143129&r2=143130
==============================================================================
--- team/group/appdocsxml/apps/app_morsecode.c (original)
+++ team/group/appdocsxml/apps/app_morsecode.c Mon Sep 15 12:22:51 2008
@@ -39,31 +39,27 @@
<synopsis>
Plays morse code
</synopsis>
+ <syntax>
+ <argument name="string" required="true">
+ <para>String to playback as morse code to channel</para>
+ </argument>
+ </syntax>
<description>
- Plays the Morse code equivalent of the passed string.
+ <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>
- <variable name="MORSEDITLEN">
- Use this value in (ms) for length of dit
- </variable>
- <variable name="MORSETONE">
- The pitch of the tone in (Hz), default is 800
- </variable>
- <option name="string" required="true">
- String to playback as morse code to channel
- </option>
</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 */
More information about the asterisk-commits
mailing list