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

[SVN commits to the Asterisk project]

Author: eliel
Date: Wed Dec  3 05:01:23 2008
New Revision: 160447

URL: http://svn.digium.com/view/asterisk?view=rev&rev=160447
Log:
- Avoid setting .synopsis and .syntax if we are using XML documentation (or the
xml documentation wont be loaded).
- Use <variable></variable> to refer to a dialplan variable.

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=160447&r1=160446&r2=160447
==============================================================================
--- trunk/apps/app_stack.c (original)
+++ trunk/apps/app_stack.c Wed Dec  3 05:01:23 2008
@@ -151,11 +151,12 @@
 			<parameter name="varname" required="true" />
 		</syntax>
 		<description>
-			<para>Read a variable <replaceable>varname</replaceable> hidden by 
+			<para>Read a variable <replaceable>varname</replaceable> hidden by
 			<replaceable>n</replaceable> levels of gosub stack frames.  Note that ${LOCAL_PEEK(0,foo)}
-			is the same as ${foo}, since the value of <replaceable>n</replaceable> peeks under 0 levels of
-			stack frames; in other words, 0 is the current level.  If <replaceable>n</replaceable> exceeds
-			the available number of stack frames, then an empty string is returned.</para>
+			is the same as <variable>foo</variable>, since the value of <replaceable>n</replaceable>
+			peeks under 0 levels of stack frames; in other words, 0 is the current level.  If
+			<replaceable>n</replaceable> exceeds the available number of stack frames, then an empty
+			string is returned.</para>
 		</description>
 		<see-also>
 			<ref type="application">Gosub</ref>
@@ -523,8 +524,6 @@
 
 static struct ast_custom_function peek_function = {
 	.name = "LOCAL_PEEK",
-	.synopsis = "Peeks at variables within the variable stack",
-	.syntax = "LOCAL_PEEK(<n>|<varname>)",
 	.read = peek_read,
 };