summaryrefslogtreecommitdiff
path: root/apps/app_nbscat.c
diff options
context:
space:
mode:
authorRussell Bryant <russell@russellbryant.com>2008-11-01 21:10:07 +0000
committerRussell Bryant <russell@russellbryant.com>2008-11-01 21:10:07 +0000
commit5b168ee34babe562be856ec8f1dd14c0abd7c1a5 (patch)
tree9c836ac808552d20be6bd2baa3a3c29f642eda53 /apps/app_nbscat.c
parent1fef0f63bbbde9530837995c8790b839f73b74e7 (diff)
Merge changes from team/group/appdocsxml
This commit introduces the first phase of an effort to manage documentation of the interfaces in Asterisk in an XML format. Currently, a new format is available for applications and dialplan functions. A good number of conversions to the new format are also included. For more information, see the following message to asterisk-dev: http://lists.digium.com/pipermail/asterisk-dev/2008-October/034968.html git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@153365 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'apps/app_nbscat.c')
-rw-r--r--apps/app_nbscat.c22
1 files changed, 14 insertions, 8 deletions
diff --git a/apps/app_nbscat.c b/apps/app_nbscat.c
index 5bc920f50..dd071ef0e 100644
--- a/apps/app_nbscat.c
+++ b/apps/app_nbscat.c
@@ -43,6 +43,19 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
#include "asterisk/translate.h"
#include "asterisk/app.h"
+/*** DOCUMENTATION
+ <application name="NBScat" language="en_US">
+ <synopsis>
+ Play an NBS local stream.
+ </synopsis>
+ <syntax />
+ <description>
+ <para>Executes nbscat to listen to the local NBS stream.
+ User can exit by pressing any key.</para>
+ </description>
+ </application>
+ ***/
+
#define LOCAL_NBSCAT "/usr/local/bin/nbscat8k"
#define NBSCAT "/usr/bin/nbscat8k"
@@ -52,13 +65,6 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
static char *app = "NBScat";
-static char *synopsis = "Play an NBS local stream";
-
-static char *descrip =
-" NBScat(): Executes nbscat to listen to the local NBS stream.\n"
-"User can exit by pressing any key.\n";
-
-
static int NBScatplay(int fd)
{
int res;
@@ -204,7 +210,7 @@ static int unload_module(void)
static int load_module(void)
{
- return ast_register_application(app, NBScat_exec, synopsis, descrip);
+ return ast_register_application_xml(app, NBScat_exec);
}
AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Silly NBS Stream Application");