From: Kinsey Moore <kmoore@digium.com>
Date: Tue, 10 Jul 2012 13:33:53 +0000 (+0000)
Subject: Improve Goto and GotoIf related documentation
X-Git-Tag: 1.8.15.0-rc1~4
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=913225a79ad332740b61a4403d3cb2f30c7f7833;p=thirdparty%2Fasterisk.git

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


git-svn-id: https://origsvn.digium.com/svn/asterisk/branches/1.8@369869 65c4cc65-6c06-0410-ace0-fbb531ad65f3
---

diff --git a/apps/app_stack.c b/apps/app_stack.c
index 13c2fcbfa8..aa597f0674 100644
--- a/apps/app_stack.c
+++ b/apps/app_stack.c
@@ -73,10 +73,14 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 			<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 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 			<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">
diff --git a/main/pbx.c b/main/pbx.c
index 485ede6344..3ecdb5c1d4 100644
--- a/main/pbx.c
+++ b/main/pbx.c
@@ -234,7 +234,9 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 		</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 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 			<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 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 				<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 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 		</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>