diff options
| author | russell <russell@f38db490-d61c-443f-a65b-d21fe96a405b> | 2008-11-01 21:10:07 +0000 |
|---|---|---|
| committer | russell <russell@f38db490-d61c-443f-a65b-d21fe96a405b> | 2008-11-01 21:10:07 +0000 |
| commit | b1f91b97d2085cc845d0f57bd9907de50c995105 (patch) | |
| tree | 9c836ac808552d20be6bd2baa3a3c29f642eda53 /funcs/func_rand.c | |
| parent | c5d084051f21e943fcbcc347fc80b166885f298d (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 'funcs/func_rand.c')
| -rw-r--r-- | funcs/func_rand.c | 25 |
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, }; |