[asterisk-commits] kmoore: branch 1.8 r369869 - in /branches/1.8: apps/app_stack.c main/pbx.c

[SVN commits to the Asterisk project]

Author: kmoore
Date: Tue Jul 10 08:33:53 2012
New Revision: 369869

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=369869
Log:
Improve Goto and GotoIf related documentation

Correct documentation on labeliftrue and labeliffalse parameters of
GotoIf() and update several other locations that use the same syntax.

(closes issue ASTERISK-20007)
Patch-by: Leif Madsen
Reported-by: WIMPy

Modified:
    branches/1.8/apps/app_stack.c
    branches/1.8/main/pbx.c

Modified: branches/1.8/apps/app_stack.c
URL: http://svnview.digium.com/svn/asterisk/branches/1.8/apps/app_stack.c?view=diff&rev=369869&r1=369868&r2=369869
==============================================================================
--- branches/1.8/apps/app_stack.c (original)
+++ branches/1.8/apps/app_stack.c Tue Jul 10 08:33:53 2012
@@ -73,10 +73,14 @@
 			<parameter name="condition" required="true" />
 			<parameter name="destination" required="true" argsep=":">
 				<argument name="labeliftrue" hasparams="optional">
+					<para>Continue at <replaceable>labeliftrue</replaceable> if the condition is true.
+					Takes the form similar to Goto() of [[context,]extension,]priority.</para>
 					<argument name="arg1" required="true" multiple="true" />
 					<argument name="argN" />
 				</argument>
 				<argument name="labeliffalse" hasparams="optional">
+					<para>Continue at <replaceable>labeliffalse</replaceable> if the condition is false.
+					Takes the form similar to Goto() of [[context,]extension,]priority.</para>
 					<argument name="arg1" required="true" multiple="true" />
 					<argument name="argN" />
 				</argument>
@@ -93,6 +97,7 @@
 			<ref type="application">MacroIf</ref>
 			<ref type="function">IF</ref>
 			<ref type="application">GotoIf</ref>
+			<ref type="application">Goto</ref>
 		</see-also>
 	</application>
 	<application name="Return" language="en_US">

Modified: branches/1.8/main/pbx.c
URL: http://svnview.digium.com/svn/asterisk/branches/1.8/main/pbx.c?view=diff&rev=369869&r1=369868&r2=369869
==============================================================================
--- branches/1.8/main/pbx.c (original)
+++ branches/1.8/main/pbx.c Tue Jul 10 08:33:53 2012
@@ -234,7 +234,9 @@
 		</description>
 		<see-also>
 			<ref type="application">Exec</ref>
+			<ref type="application">ExecIf</ref>
 			<ref type="application">TryExec</ref>
+			<ref type="application">GotoIfTime</ref>
 		</see-also>
 	</application>
 	<application name="Goto" language="en_US">
@@ -278,10 +280,12 @@
 			<parameter name="condition" required="true" />
 			<parameter name="destination" required="true" argsep=":">
 				<argument name="labeliftrue">
-					<para>Continue at <replaceable>labeliftrue</replaceable> if the condition is true.</para>
+					<para>Continue at <replaceable>labeliftrue</replaceable> if the condition is true.
+					Takes the form similar to Goto() of [[context,]extension,]priority.</para>
 				</argument>
 				<argument name="labeliffalse">
-					<para>Continue at <replaceable>labeliffalse</replaceable> if the condition is false.</para>
+					<para>Continue at <replaceable>labeliffalse</replaceable> if the condition is false.
+					Takes the form similar to Goto() of [[context,]extension,]priority.</para>
 				</argument>
 			</parameter>
 		</syntax>
@@ -320,8 +324,14 @@
 				<argument name="timezone" required="false" />
 			</parameter>
 			<parameter name="destination" required="true" argsep=":">
-				<argument name="labeliftrue" />
-				<argument name="labeliffalse" />
+				<argument name="labeliftrue">
+					<para>Continue at <replaceable>labeliftrue</replaceable> if the condition is true.
+					Takes the form similar to Goto() of [[context,]extension,]priority.</para>
+				</argument>
+				<argument name="labeliffalse">
+					<para>Continue at <replaceable>labeliffalse</replaceable> if the condition is false.
+					Takes the form similar to Goto() of [[context,]extension,]priority.</para>
+				</argument>
 			</parameter>
 		</syntax>
 		<description>
@@ -337,6 +347,7 @@
 		</description>
 		<see-also>
 			<ref type="application">GotoIf</ref>
+			<ref type="application">Goto</ref>
 			<ref type="function">IFTIME</ref>
 			<ref type="function">TESTTIME</ref>
 		</see-also>