Skip to content

Commit c35e205

Browse files
InterLinked1kharwell
authored andcommitted
documentation: Add since tag to xmldocs DTD
Adds the since tag to the documentation DTD so that individual applications, functions, etc. can now specify when they were added to Asterisk. This tag is added at the individual application, function, etc. level as opposed to at the module level because modules can expand over time as new functionality is added, and granularity only to the module level would generally not be useful. This enables the ability to more easily determine when new functionality was added to Asterisk, down to minor version as opposed to just by major version. This makes it easier for users to write more portable dialplan if desired to not use functionality that may not be widely available yet. ASTERISK-29896 #close Change-Id: Ibbb35c702d8038bdc3fd0a944fbfa69384cc15d5
1 parent e26b579 commit c35e205

File tree

2 files changed

+14
-5
lines changed

2 files changed

+14
-5
lines changed

apps/app_reload.c

+5
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,11 @@
3939

4040
/*** DOCUMENTATION
4141
<application name="Reload" language="en_US">
42+
<since>
43+
<version>16.20.0</version>
44+
<version>18.6.0</version>
45+
<version>19.0.0</version>
46+
</since>
4247
<synopsis>
4348
Reloads an Asterisk module, blocking the channel until the reload has completed.
4449
</synopsis>

doc/appdocsxml.dtd

+9-5
Original file line numberDiff line numberDiff line change
@@ -33,22 +33,22 @@
3333

3434
<!ELEMENT removed_in (#PCDATA)>
3535

36-
<!ELEMENT application (synopsis?,syntax?,description?,see-also?)>
36+
<!ELEMENT application (since?,synopsis?,syntax?,description?,see-also?)>
3737
<!ATTLIST application name CDATA #REQUIRED>
3838
<!ATTLIST application language CDATA #REQUIRED>
3939
<!ATTLIST application module CDATA #IMPLIED>
4040

41-
<!ELEMENT function (synopsis?,syntax?,description?,see-also?)>
41+
<!ELEMENT function (since?,synopsis?,syntax?,description?,see-also?)>
4242
<!ATTLIST function name CDATA #REQUIRED>
4343
<!ATTLIST function language CDATA #REQUIRED>
4444
<!ATTLIST function module CDATA #IMPLIED>
4545

46-
<!ELEMENT agi (synopsis?,syntax?,description?,see-also?)>
46+
<!ELEMENT agi (since?,synopsis?,syntax?,description?,see-also?)>
4747
<!ATTLIST agi name CDATA #REQUIRED>
4848
<!ATTLIST agi language CDATA #REQUIRED>
4949
<!ATTLIST agi module CDATA #IMPLIED>
5050

51-
<!ELEMENT manager (synopsis?,syntax?,description?,see-also?,responses?)>
51+
<!ELEMENT manager (since?,synopsis?,syntax?,description?,see-also?,responses?)>
5252
<!ATTLIST manager name CDATA #REQUIRED>
5353
<!ATTLIST manager language CDATA #REQUIRED>
5454
<!ATTLIST manager module CDATA #IMPLIED>
@@ -62,7 +62,7 @@
6262
<!ATTLIST managerEvent language CDATA #REQUIRED>
6363
<!ATTLIST managerEvent module CDATA #IMPLIED>
6464

65-
<!ELEMENT managerEventInstance (synopsis?,syntax?,description?,see-also?)*>
65+
<!ELEMENT managerEventInstance (since?,synopsis?,syntax?,description?,see-also?)*>
6666
<!ATTLIST managerEventInstance class CDATA #REQUIRED>
6767

6868
<!ELEMENT configInfo (synopsis?,description?,configFile+)>
@@ -102,6 +102,10 @@
102102
<!ATTLIST ref type (application|function|astcli|link|manpage|filename|agi|manager|managerEvent|configOption) #REQUIRED>
103103
<!ATTLIST ref module CDATA #IMPLIED>
104104

105+
<!ELEMENT since (version+)>
106+
107+
<!ELEMENT version (#PCDATA)>
108+
105109
<!ELEMENT synopsis (#PCDATA)>
106110

107111
<!ELEMENT syntax (parameter|dataType|category|matchInfo|xi:include|channel_snapshot|bridge_snapshot)*>

0 commit comments

Comments
 (0)