Skip to content
Snippets Groups Projects
Commit cb4ef23b authored by Eliel C. Sardanons's avatar Eliel C. Sardanons
Browse files

- Add ParkAndAnnounce() application XML documentation.

git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@154615 65c4cc65-6c06-0410-ace0-fbb531ad65f3
parent f18699be
No related branches found
No related tags found
No related merge requests found
...@@ -43,28 +43,47 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") ...@@ -43,28 +43,47 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
#include "asterisk/utils.h" #include "asterisk/utils.h"
#include "asterisk/app.h" #include "asterisk/app.h"
static char *app = "ParkAndAnnounce"; /*** DOCUMENTATION
<application name="ParkAndAnnounce" language="en_US">
static char *synopsis = "Park and Announce"; <synopsis>
Park and Announce.
static char *descrip = </synopsis>
" ParkAndAnnounce(announce:template,timeout,dial[,return_context]):\n" <syntax>
"Park a call into the parkinglot and announce the call to another channel.\n" <parameter name="announce_template" required="true" argsep=":">
"\n" <argument name="announce" required="true">
"announce template: Colon-separated list of files to announce. The word PARKED\n" <para>Colon-separated list of files to announce. The word
" will be replaced by a say_digits of the extension in which\n" <literal>PARKED</literal> will be replaced by a say_digits of the extension in which
" the call is parked.\n" the call is parked.</para>
"timeout: Time in seconds before the call returns into the return\n" </argument>
" context.\n" <argument name="announce1" multiple="true" />
"dial: The app_dial style resource to call to make the\n" </parameter>
" announcement. Console/dsp calls the console.\n" <parameter name="timeout" required="true">
"return_context: The goto-style label to jump the call back into after\n" <para>Time in seconds before the call returns into the return
" timeout. Default <priority+1>.\n" context.</para>
"\n" </parameter>
"The variable ${PARKEDAT} will contain the parking extension into which the\n" <parameter name="dial" required="true">
"call was placed. Use with the Local channel to allow the dialplan to make\n" <para>The app_dial style resource to call to make the
"use of this information.\n"; announcement. Console/dsp calls the console.</para>
</parameter>
<parameter name="return_context">
<para>The goto-style label to jump the call back into after
timeout. Default <literal>priority+1</literal>.</para>
</parameter>
</syntax>
<description>
<para>Park a call into the parkinglot and announce the call to another channel.</para>
<para>The variable <variable>PARKEDAT</variable> will contain the parking extension
into which the call was placed. Use with the Local channel to allow the dialplan to make
use of this information.</para>
</description>
<see-also>
<ref type="application">Park</ref>
<ref type="application">ParkedCall</ref>
</see-also>
</application>
***/
static char *app = "ParkAndAnnounce";
static int parkandannounce_exec(struct ast_channel *chan, void *data) static int parkandannounce_exec(struct ast_channel *chan, void *data)
{ {
...@@ -182,7 +201,7 @@ static int unload_module(void) ...@@ -182,7 +201,7 @@ static int unload_module(void)
static int load_module(void) static int load_module(void)
{ {
/* return ast_register_application(app, park_exec); */ /* return ast_register_application(app, park_exec); */
return ast_register_application(app, parkandannounce_exec, synopsis, descrip); return ast_register_application_xml(app, parkandannounce_exec);
} }
AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Call Parking and Announce Application"); AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Call Parking and Announce Application");
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment