diff options
author | Eliel C. Sardanons <eliels@gmail.com> | 2008-11-02 05:10:22 +0000 |
---|---|---|
committer | Eliel C. Sardanons <eliels@gmail.com> | 2008-11-02 05:10:22 +0000 |
commit | ee6a480a6c1c17556e740d77c95cebabc69c9af8 (patch) | |
tree | 47c0ae8ece80f20ec62356b4328ea863a2b61790 /apps/app_flash.c | |
parent | cdc31b1e5b3850555c5fa1f768d457bab654594c (diff) |
Add Flash() application XML documentation.
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@153543 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'apps/app_flash.c')
-rw-r--r-- | apps/app_flash.c | 28 |
1 files changed, 18 insertions, 10 deletions
diff --git a/apps/app_flash.c b/apps/app_flash.c index 46f0e3b8a..90329b6b8 100644 --- a/apps/app_flash.c +++ b/apps/app_flash.c @@ -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"); |