[asterisk-commits] eliel: branch group/appdocsxml r144627 - /team/group/appdocsxml/apps/app_image.c

[SVN commits to the Asterisk project]

Author: eliel
Date: Fri Sep 26 10:00:17 2008
New Revision: 144627

URL: http://svn.digium.com/view/asterisk?view=rev&rev=144627
Log:
Move the SendImage application documentation to XML.

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

Modified: team/group/appdocsxml/apps/app_image.c
URL: http://svn.digium.com/view/asterisk/team/group/appdocsxml/apps/app_image.c?view=diff&rev=144627&r1=144626&r2=144627
==============================================================================
--- team/group/appdocsxml/apps/app_image.c (original)
+++ team/group/appdocsxml/apps/app_image.c Fri Sep 26 10:00:17 2008
@@ -35,16 +35,35 @@
 
 static char *app = "SendImage";
 
-static char *synopsis = "Send an image file";
-
-static char *descrip = 
-"  SendImage(filename): Sends an image on a channel.\n"
-"Result of transmission will be stored in SENDIMAGESTATUS\n"
-"channel variable:\n"
-"    SUCCESS      Transmission succeeded\n"
-"    FAILURE      Transmission failed\n"
-"    UNSUPPORTED  Image transmission not supported by channel\n";
-
+/*** DOCUMENTATION
+	<application name="SendImage" language="en_US">
+		<synopsis>
+			Sends an image file.
+		</synopsis>
+		<syntax>
+			<parameter name="filename" required="true">
+				<para>Path of the filename (image) to send.</para>
+			</parameter>
+		</syntax>
+		<description>
+			<para>Send an image file on a channel supporting it.</para>
+			<variablelist>
+				<para>Result of transmission will be stored in <variable>SENDIMAGESTATUS</variable></para>
+				<variable name="SENDIMAGESTATUS">
+					<value name="SUCCESS">
+						Transmission succeeded.
+					</value>
+					<value name="FAILURE">
+						Transmission failed.
+					</value>
+					<value name="UNSUPPORTED">
+						Image transmission not supported by channel.
+					</value>
+				</variable>
+			</variablelist>
+		</description>
+	</application>
+ ***/
 
 static int sendimage_exec(struct ast_channel *chan, void *data)
 {
@@ -76,7 +95,7 @@
 
 static int load_module(void)
 {
-	return ast_register_application(app, sendimage_exec, synopsis, descrip);
+	return ast_register_application_xml(app, sendimage_exec);
 }
 
 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Image Transmission Application");