[asterisk-commits] eliel: branch group/appdocsxml r145914 - /team/group/appdocsxml/apps/

[SVN commits to the Asterisk project]

Author: eliel
Date: Thu Oct  2 12:44:31 2008
New Revision: 145914

URL: http://svn.digium.com/view/asterisk?view=rev&rev=145914
Log:
Added Transfer() application XML documentation.

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

Modified: team/group/appdocsxml/apps/app_transfer.c
URL: http://svn.digium.com/view/asterisk/team/group/appdocsxml/apps/app_transfer.c?view=diff&rev=145914&r1=145913&r2=145914
==============================================================================
--- team/group/appdocsxml/apps/app_transfer.c (original)
+++ team/group/appdocsxml/apps/app_transfer.c Thu Oct  2 12:44:31 2008
@@ -36,22 +36,46 @@
 #include "asterisk/app.h"
 #include "asterisk/channel.h"
 
+/*** DOCUMENTATION
+	<application name="Transfer" language="en_US">
+		<synopsis>
+			Transfer caller to remote extension.
+		</synopsis>
+		<syntax>
+			<parameter name="destination" required="true" argsep="/">
+				<argument name="Tech" />
+				<argument name="dest" required="true" />
+			</parameter>
+			<parameter name="options">
+				<para>No options available.</para>
+			</parameter>
+		</syntax>
+		<description>
+			<para>Requests the remote caller be transferred
+			to a given destination. If TECH (SIP, IAX2, LOCAL etc) is used, only
+			an incoming call with the same channel technology will be transfered.
+			Note that for SIP, if you transfer before call is setup, a 302 redirect
+			SIP message will be returned to the caller.</para>
+			<para>The result of the application will be reported in the <variable>TRANSFERSTATUS</variable>
+			channel variable:</para>
+			<variablelist>
+				<variable name="TRANSFERSTATUS">
+					<value name="SUCCESS">
+						Transfer succeeded.
+					</value>
+					<value name="FAILURE">
+						Transfer failed.
+					</value>
+					<value name="UNSUPPORTED">
+						Transfer unsupported by channel driver.
+					</value>
+				</variable>
+			</variablelist>
+		</description>
+	</application>
+ ***/
 
 static const char *app = "Transfer";
-
-static const char *synopsis = "Transfer caller to remote extension";
-
-static const char *descrip = 
-"  Transfer([Tech/]dest[,options]):  Requests the remote caller be transferred\n"
-"to a given destination. If TECH (SIP, IAX2, LOCAL etc) is used, only\n"
-"an incoming call with the same channel technology will be transfered.\n"
-"Note that for SIP, if you transfer before call is setup, a 302 redirect\n"
-"SIP message will be returned to the caller.\n"
-"\nThe result of the application will be reported in the TRANSFERSTATUS\n"
-"channel variable:\n"
-"       SUCCESS      Transfer succeeded\n"
-"       FAILURE      Transfer failed\n"
-"       UNSUPPORTED  Transfer unsupported by channel driver\n";
 
 static int transfer_exec(struct ast_channel *chan, void *data)
 {
@@ -119,7 +143,7 @@
 
 static int load_module(void)
 {
-	return ast_register_application(app, transfer_exec, synopsis, descrip);
+	return ast_register_application_xml(app, transfer_exec);
 }
 
 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Transfers a caller to another extension");