summaryrefslogtreecommitdiff
path: root/funcs/func_rand.c
diff options
context:
space:
mode:
Diffstat (limited to 'funcs/func_rand.c')
-rw-r--r--funcs/func_rand.c25
1 files changed, 18 insertions, 7 deletions
diff --git a/funcs/func_rand.c b/funcs/func_rand.c
index a3db21d26..079723686 100644
--- a/funcs/func_rand.c
+++ b/funcs/func_rand.c
@@ -34,6 +34,24 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
#include "asterisk/utils.h"
#include "asterisk/app.h"
+/*** DOCUMENTATION
+ <function name="RAND" language="en_US">
+ <synopsis>
+ Choose a random number in a range.
+ </synopsis>
+ <syntax>
+ <parameter name="min" />
+ <parameter name="max" />
+ </syntax>
+ <description>
+ <para>Choose a random number between <replaceable>min</replaceable> and <replaceable>max</replaceable>.
+ <replaceable>min</replaceable> defaults to <literal>0</literal>, if not specified, while <replaceable>max</replaceable> defaults
+ to <literal>RAND_MAX</literal> (2147483647 on many systems).</para>
+ <para>Example: Set(junky=${RAND(1,8)});
+ Sets junky to a random number between 1 and 8, inclusive.</para>
+ </description>
+ </function>
+ ***/
static int acf_rand_exec(struct ast_channel *chan, const char *cmd,
char *parse, char *buffer, size_t buflen)
{
@@ -68,13 +86,6 @@ static int acf_rand_exec(struct ast_channel *chan, const char *cmd,
static struct ast_custom_function acf_rand = {
.name = "RAND",
- .synopsis = "Choose a random number in a range",
- .syntax = "RAND([min][,max])",
- .desc =
- "Choose a random number between min and max. Min defaults to 0, if not\n"
- "specified, while max defaults to RAND_MAX (2147483647 on many systems).\n"
- " Example: Set(junky=${RAND(1,8)}); \n"
- " Sets junky to a random number between 1 and 8, inclusive.\n",
.read = acf_rand_exec,
};