[svn-commits] eliel: branch group/appdocsxml r146010 - /team/group/appdocsxml/apps/

[SVN commits to the Digium repositories]

Author: eliel
Date: Fri Oct  3 06:33:54 2008
New Revision: 146010

URL: http://svn.digium.com/view/asterisk?view=rev&rev=146010
Log:
Introduce ReadFile() application XML documentation, notice that a 
WARNING message is in the application description because this command is deprecated.

Modified:
    team/group/appdocsxml/apps/app_readfile.c

Modified: team/group/appdocsxml/apps/app_readfile.c
URL: http://svn.digium.com/view/asterisk/team/group/appdocsxml/apps/app_readfile.c?view=diff&rev=146010&r1=146009&r2=146010
==============================================================================
--- team/group/appdocsxml/apps/app_readfile.c (original)
+++ team/group/appdocsxml/apps/app_readfile.c Fri Oct  3 06:33:54 2008
@@ -35,16 +35,33 @@
 #include "asterisk/app.h"
 #include "asterisk/module.h"
 
+/*** DOCUMENTATION
+	<application name="ReadFile" language="en_US">
+		<synopsis>
+			Read the contents of a text file into a channel variable.
+		</synopsis>
+		<syntax argsep="=">
+			<parameter name="varname" required="true">
+				<para>Result stored here.</para>
+			</parameter>
+			<parameter name="fileparams" required="true">
+				<argument name="file" required="true">
+					<para>The name of the file to read.</para>
+				</argument>
+				<argument name="length" required="false">
+					<para>Maximum number of characters to capture.</para>
+					<para>If not specified defaults to max.</para>
+				</argument>
+			</parameter>
+		</syntax>
+		<description>
+			<para>Read the contents of a text file into channel variable <replaceable>varname</replaceable></para>
+			<warning><para>ReadFile has been deprecated in favor of Set(varname=${FILE(file,0,length)})</para></warning>
+		</description>
+	</application>
+ ***/
+
 static char *app_readfile = "ReadFile";
-
-static char *readfile_synopsis = "Read the contents of a text file into a channel variable";
-
-static char *readfile_descrip =
-"ReadFile(varname=file,length)\n"
-"  varname  - Result stored here.\n"
-"  file     - The name of the file to read.\n"
-"  length   - Maximum number of characters to capture.\n";
-
 
 static int readfile_exec(struct ast_channel *chan, void *data)
 {
@@ -101,7 +118,7 @@
 
 static int load_module(void)
 {
-	return ast_register_application(app_readfile, readfile_exec, readfile_synopsis, readfile_descrip);
+	return ast_register_application_xml(app_readfile, readfile_exec);
 }
 
 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Stores output of file into a variable");