[asterisk-commits] eliel: trunk r154467 - in /trunk: apps/app_forkcdr.c res/res_indications.c

[SVN commits to the Asterisk project]

Author: eliel
Date: Tue Nov  4 19:44:04 2008
New Revision: 154467

URL: http://svn.digium.com/view/asterisk?view=rev&rev=154467
Log:
- Add PlayTones() and StopPlayTones() applications XML documentation.
- Fix a dot that was outside of the <para> in the ForkCDR() XML documentation.

Modified:
    trunk/apps/app_forkcdr.c
    trunk/res/res_indications.c

Modified: trunk/apps/app_forkcdr.c
URL: http://svn.digium.com/view/asterisk/trunk/apps/app_forkcdr.c?view=diff&rev=154467&r1=154466&r2=154467
==============================================================================
--- trunk/apps/app_forkcdr.c (original)
+++ trunk/apps/app_forkcdr.c Tue Nov  4 19:44:04 2008
@@ -71,7 +71,7 @@
 					</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

Modified: trunk/res/res_indications.c
URL: http://svn.digium.com/view/asterisk/trunk/res/res_indications.c?view=diff&rev=154467&r1=154466&r2=154467
==============================================================================
--- trunk/res/res_indications.c (original)
+++ trunk/res/res_indications.c Tue Nov  4 19:44:04 2008
@@ -42,16 +42,43 @@
 #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 @@
 	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;
 }