aboutsummaryrefslogtreecommitdiffstats
path: root/apps/app_jack.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_jack.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_jack.c')
-rw-r--r--apps/app_jack.c52
1 files changed, 40 insertions, 12 deletions
diff --git a/apps/app_jack.c b/apps/app_jack.c
index 4da4c9f8b..14546b3c4 100644
--- a/apps/app_jack.c
+++ b/apps/app_jack.c
@@ -73,18 +73,46 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
" running.\n" \
" c(<name>) - By default, Asterisk will use the channel name for the jack client\n" \
" name. Use this option to specify a custom client name.\n"
-
+/*** DOCUMENTATION
+ <application name="JACK" language="en_US">
+ <synopsis>
+ Jack Audio Connection Kit
+ </synopsis>
+ <syntax>
+ <parameter name="options" required="false">
+ <optionlist>
+ <option name="s">
+ <argument name="name" required="true">
+ <para>Connect to the specified jack server name</para>
+ </argument>
+ </option>
+ <option name="i">
+ <argument name="name" required="true">
+ <para>Connect the output port that gets created to the specified jack input port</para>
+ </argument>
+ </option>
+ <option name="o">
+ <argument name="name" required="true">
+ <para>Connect the input port that gets created to the specified jack output port</para>
+ </argument>
+ </option>
+ <option name="c">
+ <argument name="name" required="true">
+ <para>By default, Asterisk will use the channel name for the jack client name.</para>
+ <para>Use this option to specify a custom client name.</para>
+ </argument>
+ </option>
+ </optionlist>
+ </parameter>
+ </syntax>
+ <description>
+ <para>When executing this application, two jack ports will be created;
+ one input and one output. Other applications can be hooked up to
+ these ports to access audio coming from, or being send to the channel.</para>
+ </description>
+ </application>
+ ***/
static char *jack_app = "JACK";
-static char *jack_synopsis =
-"JACK (Jack Audio Connection Kit) Application";
-static char *jack_desc =
-"JACK([options])\n"
-" When this application is executed, two jack ports will be created; one input\n"
-"and one output. Other applications can be hooked up to these ports to access\n"
-"the audio coming from, or being sent to the channel.\n"
-" Valid options:\n"
-COMMON_OPTIONS
-"";
struct jack_data {
AST_DECLARE_STRING_FIELDS(
@@ -982,7 +1010,7 @@ static int unload_module(void)
static int load_module(void)
{
- if (ast_register_application(jack_app, jack_exec, jack_synopsis, jack_desc)) {
+ if (ast_register_application_xml(jack_app, jack_exec)) {
return AST_MODULE_LOAD_DECLINE;
}