[asterisk-commits] eliel: trunk r154149 - /trunk/channels/chan_dahdi.c

[SVN commits to the Asterisk project]

Author: eliel
Date: Tue Nov  4 08:38:20 2008
New Revision: 154149

URL: http://svn.digium.com/view/asterisk?view=rev&rev=154149
Log:
Add XML documentation for:
   Applications
     - DAHDISendKeypadFacility()
     - DAHDISendCallreroutingFacility()


Modified:
    trunk/channels/chan_dahdi.c

Modified: trunk/channels/chan_dahdi.c
URL: http://svn.digium.com/view/asterisk/trunk/channels/chan_dahdi.c?view=diff&rev=154149&r1=154148&r2=154149
==============================================================================
--- trunk/channels/chan_dahdi.c (original)
+++ trunk/channels/chan_dahdi.c Tue Nov  4 08:38:20 2008
@@ -100,6 +100,41 @@
 #include "asterisk/astobj.h"
 #include "asterisk/event.h"
 #include "asterisk/devicestate.h"
+
+/*** DOCUMENTATION
+	<application name="DAHDISendKeypadFacility" language="en_US">
+		<synopsis>
+			Send digits out of band over a PRI.
+		</synopsis>
+		<syntax>
+			<parameter name="digits" required="true" />
+		</syntax>
+		<description>
+			<para>This application will send the given string of digits in a Keypad
+			Facility IE over the current channel.</para>
+		</description>
+	</application>
+	<application name="DAHDISendCallreroutingFacility" language="en_US">
+		<synopsis>
+			Send QSIG call rerouting facility over a PRI.
+		</synopsis>
+		<syntax argsep="|">
+			<parameter name="destination" required="true">
+				<para>Destination number.</para>	
+			</parameter>
+			<parameter name="original">
+				<para>Original called number.</para>
+			</parameter>
+			<parameter name="reason">
+				<para>Diversion reason, if not specified defaults to <literal>unknown</literal></para>
+			</parameter>
+		</syntax>
+		<description>
+			<para>This application will send a Callrerouting Facility IE over the
+			current channel.</para>
+		</description>
+	</application>
+ ***/
 
 #define SMDI_MD_WAIT_TIMEOUT 1500 /* 1.5 seconds */
 
@@ -2913,12 +2948,6 @@
 #ifdef HAVE_PRI
 static char *dahdi_send_keypad_facility_app = "DAHDISendKeypadFacility";
 
-static char *dahdi_send_keypad_facility_synopsis = "Send digits out of band over a PRI";
-
-static char *dahdi_send_keypad_facility_descrip = 
-"  DAHDISendKeypadFacility(): This application will send the given string of digits in a Keypad Facility\n"
-"  IE over the current channel.\n";
-
 static int dahdi_send_keypad_facility_exec(struct ast_channel *chan, void *data)
 {
 	/* Data will be our digit string */
@@ -2960,12 +2989,6 @@
 }
 
 static char *dahdi_send_callrerouting_facility_app = "DAHDISendCallreroutingFacility";
-
-static char *dahdi_send_callrerouting_facility_synopsis = "Send QSIG call rerouting facility over a PRI";
-
-static char *dahdi_send_callrerouting_facility_descrip =
-"  DAHDISendCallreroutingFacility(): This application will send a Callrerouting Facility\n"
-"  IE over the current channel.\n";
 
 static int dahdi_send_callrerouting_facility_exec(struct ast_channel *chan, void *data)
 {
@@ -14798,10 +14821,8 @@
 	}
 	pri_set_error(dahdi_pri_error);
 	pri_set_message(dahdi_pri_message);
-	ast_register_application(dahdi_send_keypad_facility_app, dahdi_send_keypad_facility_exec,
-			dahdi_send_keypad_facility_synopsis, dahdi_send_keypad_facility_descrip);
-	ast_register_application(dahdi_send_callrerouting_facility_app, dahdi_send_callrerouting_facility_exec,
-		dahdi_send_callrerouting_facility_synopsis, dahdi_send_callrerouting_facility_descrip);
+	ast_register_application_xml(dahdi_send_keypad_facility_app, dahdi_send_keypad_facility_exec);
+	ast_register_application_xml(dahdi_send_callrerouting_facility_app, dahdi_send_callrerouting_facility_exec);
 #endif
 #ifdef HAVE_SS7
 	memset(linksets, 0, sizeof(linksets));