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

SVN commits to the Asterisk project asterisk-commits at lists.digium.com
Tue Sep 30 12:51:44 CDT 2008


Author: eliel
Date: Tue Sep 30 12:51:43 2008
New Revision: 145194

URL: http://svn.digium.com/view/asterisk?view=rev&rev=145194
Log:
Implement SoftHangup application XML documentation.


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

Modified: team/group/appdocsxml/apps/app_softhangup.c
URL: http://svn.digium.com/view/asterisk/team/group/appdocsxml/apps/app_softhangup.c?view=diff&rev=145194&r1=145193&r2=145194
==============================================================================
--- team/group/appdocsxml/apps/app_softhangup.c (original)
+++ team/group/appdocsxml/apps/app_softhangup.c Tue Sep 30 12:51:43 2008
@@ -36,13 +36,28 @@
 #include "asterisk/lock.h"
 #include "asterisk/app.h"
 
-static char *synopsis = "Soft Hangup Application";
+/*** DOCUMENTATION
+	<application name="SoftHangup" language="en_US">
+		<synopsis>
+			Hangs up the requested channel.
+		</synopsis>
+		<syntax>
+			<parameter name="Technology/Resource" required="true" />
+			<parameter name="options">
+				<optionlist>
+					<option name="a">
+						<para>Hang up all channels on a specified device instead of a single resource</para>
+					</option>
+				</optionlist>
+			</parameter>
+		</syntax>	
+		<description>
+			<para>Hangs up the requested channel.  If there are no channels to 
+			hangup, the application will report it.</para>
+		</description>
+	</aplication>
 
-static char *desc = "  SoftHangup(Technology/resource[,options]):\n"
-"Hangs up the requested channel.  If there are no channels to hangup,\n"
-"the application will report it.\n"
-"  Options:\n"
-"     'a'  - hang up all channels on a specified device instead of a single resource\n";
+ ***/
 
 static char *app = "SoftHangup";
 
@@ -114,7 +129,7 @@
 
 static int load_module(void)
 {
-	return ast_register_application(app, softhangup_exec, synopsis, desc);
+	return ast_register_application_xml(app, softhangup_exec);
 }
 
 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Hangs up the requested channel");




More information about the asterisk-commits mailing list