summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKinsey Moore <kmoore@digium.com>2012-07-10 13:40:32 +0000
committerKinsey Moore <kmoore@digium.com>2012-07-10 13:40:32 +0000
commit6416a246edb7aca07a595098515591af7a92fb94 (patch)
tree1027672e1df88e74760ecdeb0a75daa7a5a6b3b1
parentb1bb826350a828745b0ecf4751fdb79f88e8a83a (diff)
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 ........ Merged revisions 369869 from http://svn.asterisk.org/svn/asterisk/branches/1.8 ........ Merged revisions 369871 from http://svn.asterisk.org/svn/asterisk/branches/10 git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@369872 65c4cc65-6c06-0410-ace0-fbb531ad65f3
-rw-r--r--apps/app_stack.c5
-rw-r--r--main/pbx.c19
2 files changed, 20 insertions, 4 deletions
diff --git a/apps/app_stack.c b/apps/app_stack.c
index 66d39b3c9..00a63480d 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 db929519e..95f6fda62 100644
--- a/main/pbx.c
+++ b/main/pbx.c
@@ -235,7 +235,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">
@@ -279,10 +281,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>
@@ -321,8 +325,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>
@@ -338,6 +348,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>