aboutsummaryrefslogtreecommitdiffstats
path: root/apps/app_festival.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_festival.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_festival.c')
-rw-r--r--apps/app_festival.c27
1 files changed, 18 insertions, 9 deletions
diff --git a/apps/app_festival.c b/apps/app_festival.c
index 4a929a3e5..82f1bddc5 100644
--- a/apps/app_festival.c
+++ b/apps/app_festival.c
@@ -53,15 +53,24 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
#define MAXLEN 180
#define MAXFESTLEN 2048
-static char *app = "Festival";
-
-static char *synopsis = "Say text to the user";
-
-static char *descrip =
-" Festival(text[,intkeys]): Connect to Festival, send the argument, get back the waveform,\n"
-"play it to the user, allowing any given interrupt keys to immediately terminate and return\n"
-"the value, or 'any' to allow any number back (useful in dialplan)\n";
+/*** DOCUMENTATION
+ <application name="Festival" language="en_US">
+ <synopsis>
+ Say text to the user.
+ </synopsis>
+ <syntax>
+ <parameter name="text" required="true" />
+ <parameter name="intkeys" />
+ </syntax>
+ <description>
+ <para>Connect to Festival, send the argument, get back the waveform, play it to the user,
+ allowing any given interrupt keys to immediately terminate and return the value, or
+ <literal>any</literal> to allow any number back (useful in dialplan).</para>
+ </description>
+ </application>
+ ***/
+static char *app = "Festival";
static char *socket_receive_file_to_buff(int fd, int *size)
{
@@ -526,7 +535,7 @@ static int load_module(void)
return AST_MODULE_LOAD_DECLINE;
}
ast_config_destroy(cfg);
- return ast_register_application(app, festival_exec, synopsis, descrip);
+ return ast_register_application_xml(app, festival_exec);
}
AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Simple Festival Interface");