Add Flash() application XML documentation.
authorEliel C. Sardanons <eliels@gmail.com>
Sun, 2 Nov 2008 05:10:22 +0000 (05:10 +0000)
committerEliel C. Sardanons <eliels@gmail.com>
Sun, 2 Nov 2008 05:10:22 +0000 (05:10 +0000)
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@153543 65c4cc65-6c06-0410-ace0-fbb531ad65f3

apps/app_flash.c

index 46f0e3b..90329b6 100644 (file)
@@ -43,16 +43,24 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 #include "asterisk/translate.h"
 #include "asterisk/image.h"
 
-static char *app = "Flash";
-
-static char *synopsis = "Flashes a DAHDI Trunk";
-
-static char *descrip = 
-"Performs a flash on a DAHDI trunk.  This can be used\n"
-"to access features provided on an incoming analogue circuit\n"
-"such as conference and call waiting. Use with SendDTMF() to\n"
-"perform external transfers\n";
+/*** DOCUMENTATION
+       <application name="Flash" language="en_US">
+               <synopsis>
+                       Flashes a DAHDI Trunk.
+               </synopsis>
+               <syntax />
+               <description>
+                       <para>Performs a flash on a DAHDI trunk. This can be used to access features
+                       provided on an incoming analogue circuit such as conference and call waiting.
+                       Use with SendDTMF() to perform external transfers.</para>
+               </description>
+               <see-also>
+                       <ref type="application">SendDTMF</ref>
+               </see-also>
+       </application>
+ ***/
 
+static char *app = "Flash";
 
 static inline int dahdi_wait_event(int fd)
 {
@@ -105,7 +113,7 @@ static int unload_module(void)
 
 static int load_module(void)
 {
-       return ast_register_application(app, flash_exec, synopsis, descrip);
+       return ast_register_application_xml(app, flash_exec);
 }
 
 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Flash channel application");