documentation: Update Gosub, Goto, and add new documentationtype.

Gosub and Goto were not displaying their syntax correctly on the docs
site. This change adds a new way to specify an optional context, an
optional extension, and a required priority that the xml stylesheet can
parse without having to know which optional parameters come in which
order. In Asterisk, it looks like this:

  parameter name="context" documentationtype="dialplan_context"
  parameter name="extension" documentationtype="dialplan_extension"
  parameter name="priority" documentationtype="dialplan_priority" required="true"

The stylesheet will ignore the context and extension parameters, but for
priority, it will automatically inject the following:

  [[context,]extension,]priority

This is the correct oder for applications such as Gosub and Goto.

(cherry picked from commit 53766c5a745170153b5708ae1e14dee18ac90fd7)

diff --git a/apps/app_stack.c b/apps/app_stack.c
index a927cb574ba2bddb9fda382fdd3e50e27dfb1c16..b611d2d6f0760aab2693732917284c14d0433e1a 100644 (file)
--- a/apps/app_stack.c
+++ b/apps/app_stack.c
@@ -46,9 +46,9 @@
                        Jump to label, saving return address.
                </synopsis>
                <syntax>
-                       <parameter name="context" />
-                       <parameter name="exten" />
-                       <parameter name="priority" required="true" hasparams="optional">
+                       <parameter name="context" documentationtype="dialplan_context" />
+                       <parameter name="extension" documentationtype="dialplan_extension" />
+                       <parameter name="priority" documentationtype="dialplan_priority" required="true" hasparams="optional">
                                <argument name="arg1" multiple="true" required="true" />
                                <argument name="argN" />
                        </parameter>

diff --git a/doc/appdocsxml.dtd b/doc/appdocsxml.dtd
index 05482f8052e97191fcb8b180d2857d72d317760f..1ae9978a5fdef2ebce43d3da068f327e086c06ac 100644 (file)
--- a/doc/appdocsxml.dtd
+++ b/doc/appdocsxml.dtd
@@ -118,7 +118,7 @@
 
   <!ELEMENT description (para|note|warning|variablelist|enumlist|info|example|xi:include)*>
 
-  <!ELEMENT parameter (optionlist|enumlist|argument|para|note|warning|parameter|info|xi:include)*>
+  <!ELEMENT parameter (optionlist|enumlist|argument|para|note|warning|parameter|info|documentationtype|xi:include)*>
   <!ATTLIST parameter name CDATA "">
   <!ATTLIST parameter required (yes|no|true|false) "false">
   <!ATTLIST parameter multiple (yes|no|true|false) "false">
@@ -126,6 +126,7 @@
   <!ATTLIST parameter literal (yes|no|true|false) "false">
   <!ATTLIST parameter default CDATA "">
   <!ATTLIST parameter argsep CDATA ",">
+  <!ATTLIST parameter documentationtype CDATA "">
 
   <!ELEMENT optionlist (option+)>
   <!ELEMENT option (argument|para|note|warning|variablelist|enumlist|info|xi:include)*>

diff --git a/main/pbx_builtins.c b/main/pbx_builtins.c
index 6c1499a7b4f90ecdc0ab4fc451c66042e658c30d..a59b16d895dd4833aa07939ff689665694f3a824 100644 (file)
--- a/main/pbx_builtins.c
+++ b/main/pbx_builtins.c
@@ -187,9 +187,9 @@
                        Jump to a particular priority, extension, or context.
                </synopsis>
                <syntax>
-                       <parameter name="context" />
-                       <parameter name="extensions" />
-                       <parameter name="priority" required="true" />
+                       <parameter name="context" documentationtype="dialplan_context" />
+                       <parameter name="extension" documentationtype="dialplan_extension" />
+                       <parameter name="priority" documentationtype="dialplan_priority" required="true" />
                </syntax>
                <description>
                        <para>This application will set the current context, extension, and priority in the channel structure.