aboutsummaryrefslogtreecommitdiffstats
path: root/apps/app_ices.c
diff options
context:
space:
mode:
authorrussell <russell@f38db490-d61c-443f-a65b-d21fe96a405b>2008-11-01 21:10:07 +0000
committerrussell <russell@f38db490-d61c-443f-a65b-d21fe96a405b>2008-11-01 21:10:07 +0000
commitb1f91b97d2085cc845d0f57bd9907de50c995105 (patch)
tree9c836ac808552d20be6bd2baa3a3c29f642eda53 /apps/app_ices.c
parentc5d084051f21e943fcbcc347fc80b166885f298d (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: http://svn.digium.com/svn/asterisk/trunk@153365 f38db490-d61c-443f-a65b-d21fe96a405b
Diffstat (limited to 'apps/app_ices.c')
-rw-r--r--apps/app_ices.c31
1 files changed, 20 insertions, 11 deletions
diff --git a/apps/app_ices.c b/apps/app_ices.c
index 1da17369b..4126ad7e9 100644
--- a/apps/app_ices.c
+++ b/apps/app_ices.c
@@ -45,21 +45,30 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
#include "asterisk/translate.h"
#include "asterisk/app.h"
+/*** DOCUMENTATION
+ <application name="ICES" language="en_US">
+ <synopsis>
+ Encode and stream using 'ices'.
+ </synopsis>
+ <syntax>
+ <parameter name="config" required="true">
+ <para>ICES configuration file.</para>
+ </parameter>
+ </syntax>
+ <description>
+ <para>Streams to an icecast server using ices (available separately).
+ A configuration file must be supplied for ices (see contrib/asterisk-ices.xml).</para>
+ <note><para>ICES version 2 cient and server required.</para></note>
+ </description>
+ </application>
+
+ ***/
+
#define path_BIN "/usr/bin/"
#define path_LOCAL "/usr/local/bin/"
static char *app = "ICES";
-static char *synopsis = "Encode and stream using 'ices'";
-
-static char *descrip =
-" ICES(config.xml) Streams to an icecast server using ices\n"
-"(available separately). A configuration file must be supplied\n"
-"for ices (see contrib/asterisk-ices.xml). \n"
-"\n"
-"- ICES version 2 cient and server required.\n";
-
-
static int icesencode(char *filename, int fd)
{
int res;
@@ -199,7 +208,7 @@ static int unload_module(void)
static int load_module(void)
{
- return ast_register_application(app, ices_exec, synopsis, descrip);
+ return ast_register_application_xml(app, ices_exec);
}
AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Encode and Stream via icecast and ices");