[asterisk-commits] eliel: trunk r153947 - /trunk/apps/app_stack.c

[SVN commits to the Asterisk project]

Author: eliel
Date: Mon Nov  3 11:11:22 2008
New Revision: 153947

URL: http://svn.digium.com/view/asterisk?view=rev&rev=153947
Log:
Add LOCAL() function XML documentation.


Modified:
    trunk/apps/app_stack.c

Modified: trunk/apps/app_stack.c
URL: http://svn.digium.com/view/asterisk/trunk/apps/app_stack.c?view=diff&rev=153947&r1=153946&r2=153947
==============================================================================
--- trunk/apps/app_stack.c (original)
+++ trunk/apps/app_stack.c Mon Nov  3 11:11:22 2008
@@ -106,6 +106,23 @@
 			<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 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,
 };