kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-09-02 11:06:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
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.
This commit is contained in:
Ben Ford
2025-03-14 17:05:30 -05:00
parent 0900f83820
commit 091171c0eb
3 changed files with 8 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
apps/app_stack.c
View File

@@ -49,9 +49,9 @@
Jump to label, saving return address. Jump to label, saving return address.
</synopsis> </synopsis>
<syntax> <syntax>
<parameter name="context" /> <parameter name="context" documentationtype="dialplan_context" />
<parameter name="exten" /> <parameter name="extension" documentationtype="dialplan_extension" />
<parameter name="priority" required="true" hasparams="optional"> <parameter name="priority" documentationtype="dialplan_priority" required="true" hasparams="optional">
<argument name="arg1" multiple="true" required="true" /> <argument name="arg1" multiple="true" required="true" />
<argument name="argN" /> <argument name="argN" />
</parameter> </parameter>

3
doc/appdocsxml.dtd
View File

@@ -122,7 +122,7 @@
<!ELEMENT description (para|note|warning|variablelist|enumlist|info|example|xi:include)*> <!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 name CDATA "">
<!ATTLIST parameter required (yes|no|true|false) "false"> <!ATTLIST parameter required (yes|no|true|false) "false">
<!ATTLIST parameter multiple (yes|no|true|false) "false"> <!ATTLIST parameter multiple (yes|no|true|false) "false">
@@ -130,6 +130,7 @@
<!ATTLIST parameter literal (yes|no|true|false) "false"> <!ATTLIST parameter literal (yes|no|true|false) "false">
<!ATTLIST parameter default CDATA ""> <!ATTLIST parameter default CDATA "">
<!ATTLIST parameter argsep CDATA ","> <!ATTLIST parameter argsep CDATA ",">
<!ATTLIST parameter documentationtype CDATA "">
<!ELEMENT optionlist (option+)> <!ELEMENT optionlist (option+)>
<!ELEMENT option (argument|para|note|warning|variablelist|enumlist|info|xi:include)*> <!ELEMENT option (argument|para|note|warning|variablelist|enumlist|info|xi:include)*>

6
main/pbx_builtins.c
View File

@@ -227,9 +227,9 @@
Jump to a particular priority, extension, or context. Jump to a particular priority, extension, or context.
</synopsis> </synopsis>
<syntax> <syntax>
<parameter name="context" /> <parameter name="context" documentationtype="dialplan_context" />
<parameter name="extensions" /> <parameter name="extension" documentationtype="dialplan_extension" />
<parameter name="priority" required="true" /> <parameter name="priority" documentationtype="dialplan_priority" required="true" />
</syntax> </syntax>
<description> <description>
<para>This application will set the current context, extension, and priority in the channel structure. <para>This application will set the current context, extension, and priority in the channel structure.