From 5b168ee34babe562be856ec8f1dd14c0abd7c1a5 Mon Sep 17 00:00:00 2001
From: Russell Bryant <russell@russellbryant.com>
Date: Sat, 1 Nov 2008 21:10:07 +0000
Subject: 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
---
 apps/app_readfile.c | 37 +++++++++++++++++++++++++++----------
 1 file changed, 27 insertions(+), 10 deletions(-)

(limited to 'apps/app_readfile.c')

diff --git a/apps/app_readfile.c b/apps/app_readfile.c
index 8762ef860..c5234089f 100644
--- a/apps/app_readfile.c
+++ b/apps/app_readfile.c
@@ -35,16 +35,33 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 #include "asterisk/app.h"
 #include "asterisk/module.h"
 
-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";
+/*** 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 int readfile_exec(struct ast_channel *chan, void *data)
 {
@@ -101,7 +118,7 @@ static int unload_module(void)
 
 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");
-- 
cgit v1.2.3