aboutsummaryrefslogtreecommitdiffstats
path: root/apps/app_waituntil.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_waituntil.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_waituntil.c')
-rw-r--r--apps/app_waituntil.c41
1 files changed, 32 insertions, 9 deletions
diff --git a/apps/app_waituntil.c b/apps/app_waituntil.c
index 8b903b0ba..0b6ccc677 100644
--- a/apps/app_waituntil.c
+++ b/apps/app_waituntil.c
@@ -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");