summaryrefslogtreecommitdiff
path: root/apps
diff options
context:
space:
mode:
authorEliel C. Sardanons <eliels@gmail.com>2008-11-03 17:11:22 +0000
committerEliel C. Sardanons <eliels@gmail.com>2008-11-03 17:11:22 +0000
commit3873227e9d6ad1f89327a8fad02c3d2707874d15 (patch)
tree870b5ec7249fc44157b22a8fe4679143c895c70c /apps
parentd3517de987339e3f4176eba46994bc81b513518a (diff)
Add LOCAL() function XML documentation.
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@153947 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'apps')
-rw-r--r--apps/app_stack.c19
1 files changed, 17 insertions, 2 deletions
diff --git a/apps/app_stack.c b/apps/app_stack.c
index 3f73e13d6..beeea30f6 100644
--- a/apps/app_stack.c
+++ b/apps/app_stack.c
@@ -106,6 +106,23 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
<para>Removes last label on the stack, discarding it.</para>
</description>
</application>
+ <function name="LOCAL" language="en_US">
+ <synopsis>
+ Manage variables local to the gosub stack frame.
+ </synopsis>
+ <syntax>
+ <parameter name="varname" required="true" />
+ </syntax>
+ <description>
+ <para>Read and write a variable local to the gosub stack frame, once we Return() it will be lost
+ (or it will go back to whatever value it had before the Gosub()).</para>
+ </description>
+ <see-also>
+ <ref type="application">Gosub</ref>
+ <ref type="application">GosubIf</ref>
+ <ref type="application">Return</ref>
+ </see-also>
+ </function>
***/
static const char *app_gosub = "Gosub";
@@ -431,8 +448,6 @@ static int local_write(struct ast_channel *chan, const char *cmd, char *var, con
static struct ast_custom_function local_function = {
.name = "LOCAL",
- .synopsis = "Variables local to the gosub stack frame",
- .syntax = "LOCAL(<varname>)",
.write = local_write,
.read = local_read,
};