mirror of
https://github.com/asterisk/asterisk.git
synced 2025-09-03 03:20:57 +00:00
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
This commit is contained in:
@@ -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");
|
||||
|
Reference in New Issue
Block a user