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

docs: Add version information to application and function XML elements

Browse Source 
* Do a git blame on the embedded XML application or function element.

* From the commit hash, grab the summary line.

* Do a git log --grep <summary> to find the cherry-pick commits in all
  branches that match.

* Do a git patch-id to ensure the commits are all related and didn't get
  a false match on the summary.

* Do a git tag --contains <commit> to find the tags that contain each
  commit.

* Weed out all tags not ..0.

* Sort and discard any .0.0 and following tags where the commit
  appeared in an earlier branch.

* The result is a single tag for each branch where the application or function
  was defined.

The applications and functions defined in the following files were done by
hand because the XML was extracted from the C source file relatively recently.
* channels/pjsip/dialplan_functions_doc.xml
* main/logger_doc.xml
* main/manager_doc.xml
* res/res_geolocation/geoloc_doc.xml
* res/res_stir_shaken/stir_shaken_doc.xml

(cherry picked from commit 85a4ab8390)
This commit is contained in:
George Joseph
2025-01-23 09:27:32 -07:00
committed by Asterisk Development Team
parent 8c07517a6f
commit a80179bfe7
166 changed files with 385 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
main/ccss.c
View File

@@ -54,6 +54,7 @@
/*** DOCUMENTATION
<application name="CallCompletionRequest" language="en_US">
<since><version>1.8.0</version></since>
<synopsis>
Request call completion service for previous call
</synopsis>
@@ -79,6 +80,7 @@
</description>
</application>
<application name="CallCompletionCancel" language="en_US">
<since><version>1.8.0</version></since>
<synopsis>
Cancel call completion service
</synopsis>

1
main/features.c
View File

@@ -80,6 +80,7 @@
/*** DOCUMENTATION
<application name="Bridge" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Bridge two channels.
</synopsis>

2
main/features_config.c
View File

@@ -310,6 +310,7 @@
</configFile>
</configInfo>
<function name="FEATURE" language="en_US">
<since><version>12.0.0</version></since>
<synopsis>
Get or set a feature option on a channel.
</synopsis>
@@ -353,6 +354,7 @@
</see-also>
</function>
<function name="FEATUREMAP" language="en_US">
<since><version>12.0.0</version></since>
<synopsis>
Get or set a feature map to a given value on a specific channel.
</synopsis>

1
main/logger_doc.xml
View File

@@ -3,6 +3,7 @@
<?xml-stylesheet type="text/xsl" href="appdocsxml.xslt"?>
<docs xmlns:xi="http://www.w3.org/2001/XInclude">
<function name="LOG_GROUP" language="en_US">
<since><version>18.21.0</version><version>20.6.0</version><version>21.1.0</version></since>
<synopsis>
Set the channel group name for log filtering on this channel
</synopsis>

1
main/manager_doc.xml
View File

@@ -1400,6 +1400,7 @@
</see-also>
</manager>
<function name="AMI_CLIENT" language="en_US">
<since><version>11.0.0</version></since>
<synopsis>
Checks attributes of manager accounts
</synopsis>

3
main/message.c
View File

@@ -44,6 +44,7 @@
/*** DOCUMENTATION
<function name="MESSAGE" language="en_US">
<since><version>10.0.0</version></since>
<synopsis>
Create a message or read fields from a message.
</synopsis>
@@ -104,6 +105,7 @@
</see-also>
</function>
<function name="MESSAGE_DATA" language="en_US">
<since><version>10.0.0</version></since>
<synopsis>
Read or write custom data attached to a message.
</synopsis>
@@ -127,6 +129,7 @@
</see-also>
</function>
<application name="MessageSend" language="en_US">
<since><version>10.0.0</version></since>
<synopsis>
Send a text message.
</synopsis>

2
main/pbx.c
View File

@@ -96,6 +96,7 @@
/*** DOCUMENTATION
<function name="EXCEPTION" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Retrieve the details of the current dialplan exception.
</synopsis>
@@ -127,6 +128,7 @@
</see-also>
</function>
<function name="TESTTIME" language="en_US">
<since><version>1.8.0</version></since>
<synopsis>
Sets a time to be used with the channel to test logical conditions.
</synopsis>

25
main/pbx_builtins.c
View File

@@ -42,6 +42,7 @@
/*** DOCUMENTATION
<application name="Answer" language="en_US">
<since><version>13.8.0</version></since>
<synopsis>
Answer a channel if ringing.
</synopsis>
@@ -72,6 +73,7 @@
</see-also>
</application>
<application name="BackGround" language="en_US">
<since><version>13.8.0</version></since>
<synopsis>
Play an audio file while waiting for digits of an extension to go to.
</synopsis>
@@ -138,6 +140,7 @@
</see-also>
</application>
<application name="Busy" language="en_US">
<since><version>13.8.0</version></since>
<synopsis>
Indicate the Busy condition.
</synopsis>
@@ -158,6 +161,7 @@
</see-also>
</application>
<application name="Congestion" language="en_US">
<since><version>13.8.0</version></since>
<synopsis>
Indicate the Congestion condition.
</synopsis>
@@ -178,6 +182,7 @@
</see-also>
</application>
<application name="ExecIfTime" language="en_US">
<since><version>13.8.0</version></since>
<synopsis>
Conditional application execution based on the current time.
</synopsis>
@@ -205,6 +210,7 @@
</see-also>
</application>
<application name="Goto" language="en_US">
<since><version>13.8.0</version></since>
<synopsis>
Jump to a particular priority, extension, or context.
</synopsis>
@@ -237,6 +243,7 @@
</see-also>
</application>
<application name="GotoIf" language="en_US">
<since><version>13.8.0</version></since>
<synopsis>
Conditional goto.
</synopsis>
@@ -275,6 +282,7 @@
</see-also>
</application>
<application name="GotoIfTime" language="en_US">
<since><version>13.8.0</version></since>
<synopsis>
Conditional Goto based on the current time.
</synopsis>
@@ -316,6 +324,7 @@
</see-also>
</application>
<application name="Hangup" language="en_US">
<since><version>13.8.0</version></since>
<synopsis>
Hang up the calling channel.
</synopsis>
@@ -335,6 +344,7 @@
</see-also>
</application>
<application name="Incomplete" language="en_US">
<since><version>13.8.0</version></since>
<synopsis>
Returns AST_PBX_INCOMPLETE value.
</synopsis>
@@ -352,6 +362,7 @@
</description>
</application>
<application name="NoOp" language="en_US">
<since><version>13.8.0</version></since>
<synopsis>
Do Nothing (No Operation).
</synopsis>
@@ -370,6 +381,7 @@
</see-also>
</application>
<application name="Proceeding" language="en_US">
<since><version>13.8.0</version></since>
<synopsis>
Indicate proceeding.
</synopsis>
@@ -379,6 +391,7 @@
</description>
</application>
<application name="Progress" language="en_US">
<since><version>13.8.0</version></since>
<synopsis>
Indicate progress.
</synopsis>
@@ -394,6 +407,7 @@
</see-also>
</application>
<application name="RaiseException" language="en_US">
<since><version>13.8.0</version></since>
<synopsis>
Handle an exceptional condition.
</synopsis>
@@ -409,6 +423,7 @@
</see-also>
</application>
<application name="Ringing" language="en_US">
<since><version>13.8.0</version></since>
<synopsis>
Indicate ringing tone.
</synopsis>
@@ -424,6 +439,7 @@
</see-also>
</application>
<application name="SayAlpha" language="en_US">
<since><version>13.8.0</version></since>
<synopsis>
Say Alpha.
</synopsis>
@@ -448,6 +464,7 @@
</see-also>
</application>
<application name="SayAlphaCase" language="en_US">
<since><version>13.8.0</version></since>
<synopsis>
Say Alpha.
</synopsis>
@@ -492,6 +509,7 @@
</see-also>
</application>
<application name="SayDigits" language="en_US">
<since><version>13.8.0</version></since>
<synopsis>
Say Digits.
</synopsis>
@@ -516,6 +534,7 @@
</see-also>
</application>
<application name="SayMoney" language="en_US">
<since><version>16.21.0</version><version>18.7.0</version></since>
<synopsis>
Say Money.
</synopsis>
@@ -539,6 +558,7 @@
</see-also>
</application>
<application name="SayNumber" language="en_US">
<since><version>13.8.0</version></since>
<synopsis>
Say Number.
</synopsis>
@@ -564,6 +584,7 @@
</see-also>
</application>
<application name="SayOrdinal" language="en_US">
<since><version>16.21.0</version><version>18.7.0</version></since>
<synopsis>
Say Ordinal Number.
</synopsis>
@@ -591,6 +612,7 @@
</see-also>
</application>
<application name="SayPhonetic" language="en_US">
<since><version>13.8.0</version></since>
<synopsis>
Say Phonetic.
</synopsis>
@@ -613,6 +635,7 @@
</see-also>
</application>
<application name="Wait" language="en_US">
<since><version>13.8.0</version></since>
<synopsis>
Waits for some time.
</synopsis>
@@ -627,6 +650,7 @@
</description>
</application>
<application name="WaitDigit" language="en_US">
<since><version>15.0.0</version></since>
<synopsis>
Waits for a digit to be entered.
</synopsis>
@@ -663,6 +687,7 @@
</see-also>
</application>
<application name="WaitExten" language="en_US">
<since><version>13.8.0</version></since>
<synopsis>
Waits for an extension to be entered.
</synopsis>

2
main/pbx_variables.c
View File

@@ -45,6 +45,7 @@
/*** DOCUMENTATION
<application name="Set" language="en_US">
<since><version>13.8.0</version></since>
<synopsis>
Set channel variable or function value.
</synopsis>
@@ -75,6 +76,7 @@
</see-also>
</application>
<application name="MSet" language="en_US">
<since><version>13.8.0</version></since>
<synopsis>
Set channel variable(s) or function value(s).
</synopsis>