summaryrefslogtreecommitdiff
path: root/apps/app_waitforring.c
diff options
context:
space:
mode:
authorEliel C. Sardanons <eliels@gmail.com>2008-11-03 01:01:25 +0000
committerEliel C. Sardanons <eliels@gmail.com>2008-11-03 01:01:25 +0000
commit9167a2b5e164687d4c9a0618a42d0dfe30090b9b (patch)
tree81df3f713ae7c89cfb8228bf411a5e9eb673293a /apps/app_waitforring.c
parenta67790c6f53e4b002556eca8438dbd56994ea056 (diff)
Add XML documentation for:
- WaitForSilence() - WaitForNoise() - WaitForRing() - IVRDemo() - DBDel() - DBDeltree() (issue #13699) Reported by: snuffy Patches: bug13699_20081016.diff uploaded by snuffy (license 35) (With minor changes) git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@153747 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'apps/app_waitforring.c')
-rw-r--r--apps/app_waitforring.c24
1 files changed, 16 insertions, 8 deletions
diff --git a/apps/app_waitforring.c b/apps/app_waitforring.c
index f2d21e516..fd5913e04 100644
--- a/apps/app_waitforring.c
+++ b/apps/app_waitforring.c
@@ -35,16 +35,24 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
#include "asterisk/module.h"
#include "asterisk/lock.h"
-static char *synopsis = "Wait for Ring Application";
-
-static char *desc = " WaitForRing(timeout):\n"
-"Returns 0 after waiting at least timeout seconds. and\n"
-"only after the next ring has completed. Returns 0 on\n"
-"success or -1 on hangup\n";
+/*** DOCUMENTATION
+ <application name="WaitForRing" language="en_US">
+ <synopsis>
+ Wait for Ring Application.
+ </synopsis>
+ <syntax>
+ <parameter name="timeout" required="true" />
+ </syntax>
+ <description>
+ <para>Returns <literal>0</literal> after waiting at least <replaceable>timeout</replaceable> seconds,
+ and only after the next ring has completed. Returns <literal>0</literal> on success or
+ <literal>-1</literal> on hangup.</para>
+ </description>
+ </application>
+ ***/
static char *app = "WaitForRing";
-
static int waitforring_exec(struct ast_channel *chan, void *data)
{
struct ast_frame *f;
@@ -111,7 +119,7 @@ static int unload_module(void)
static int load_module(void)
{
- return ast_register_application(app, waitforring_exec, synopsis, desc);
+ return ast_register_application_xml(app, waitforring_exec);
}
AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Waits until first ring after time");