kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2026-06-09 03:45:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge changes from team/group/appdocsxml

Browse Source 
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
This commit is contained in:
Russell Bryant
2008-11-01 21:10:07 +00:00
parent 1fef0f63bb
commit 5b168ee34b
111 changed files with 8063 additions and 2478 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
apps/app_waituntil.c
View File

@@ -34,15 +34,38 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
#include "asterisk/pbx.h"
#include "asterisk/module.h"
/*** DOCUMENTATION
<application name="WaitUntil" language="en_US">
<synopsis>
Wait (sleep) until the current time is the given epoch.
</synopsis>
<syntax>
<parameter name="epoch" required="true" />
</syntax>
<description>
<para>Waits until the given <replaceable>epoch</replaceable>.</para>
<para>Sets <variable>WAITUNTILSTATUS</variable> to one of the following values:</para>
<variablelist>
<variable name="WAITUNTILSTATUS">
<value name="OK">
Wait succeeded.
</value>
<value name="FAILURE">
Invalid argument.
</value>
<value name="HANGUP">
Channel hungup before time elapsed.
</value>
<value name="PAST">
Time specified had already past.
</value>
</variable>
</variablelist>
</description>
</application>
***/
static char *app = "WaitUntil";
static char *synopsis = "Wait (sleep) until the current time is the given epoch";
static char *descrip =
" WaitUntil(<epoch>): Waits until the given time. Sets WAITUNTILSTATUS to\n"
"one of the following values:\n"
" OK Wait succeeded\n"
" FAILURE Invalid argument\n"
" HANGUP Channel hung up before time elapsed\n"
" PAST The time specified was already past\n";
static int waituntil_exec(struct ast_channel *chan, void *data)
{
@@ -89,7 +112,7 @@ static int unload_module(void)
static int load_module(void)
{
return ast_register_application(app, waituntil_exec, synopsis, descrip);
return ast_register_application_xml(app, waituntil_exec);
}
AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Wait until specified time");