docs: Add version information to application and function XML elements

* 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 54d67711f8)
This commit is contained in:
George Joseph
2025-01-23 09:27:32 -07:00
committed by Asterisk Development Team
parent 3fc90e7810
commit e6fe538d81
165 changed files with 383 additions and 27 deletions

View File

@@ -126,6 +126,7 @@
/*** DOCUMENTATION
<application name="Queue" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Queue a call for a call queue.
</synopsis>
@@ -331,6 +332,7 @@
</see-also>
</application>
<application name="AddQueueMember" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Dynamically adds queue members.
</synopsis>
@@ -384,6 +386,7 @@
</see-also>
</application>
<application name="RemoveQueueMember" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Dynamically removes queue members.
</synopsis>
@@ -424,6 +427,7 @@
</see-also>
</application>
<application name="PauseQueueMember" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Pauses a queue member.
</synopsis>
@@ -471,6 +475,7 @@
</see-also>
</application>
<application name="UnpauseQueueMember" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Unpauses a queue member.
</synopsis>
@@ -515,6 +520,7 @@
</see-also>
</application>
<application name="QueueLog" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Writes to the queue_log file.
</synopsis>
@@ -549,6 +555,7 @@
</see-also>
</application>
<application name="QueueUpdate" language="en_US">
<since><version>15.0.0</version></since>
<synopsis>
Writes to the queue_log file for outbound calls and updates Realtime Data.
Is used at h extension to be able to have all the parameters.
@@ -569,6 +576,7 @@
</description>
</application>
<function name="QUEUE_VARIABLES" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Return Queue information in variables.
</synopsis>
@@ -624,6 +632,7 @@
</see-also>
</function>
<function name="QUEUE_MEMBER" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Provides a count of queue members based on the provided criteria, or updates a
queue member's settings.
@@ -689,6 +698,7 @@
</see-also>
</function>
<function name="QUEUE_MEMBER_COUNT" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Count number of members answering a queue.
</synopsis>
@@ -717,6 +727,7 @@
</see-also>
</function>
<function name="QUEUE_EXISTS" language="en_US">
<since><version>1.8.0</version></since>
<synopsis>
Check if a named queue exists on this server
</synopsis>
@@ -744,6 +755,7 @@
</see-also>
</function>
<function name="QUEUE_GET_CHANNEL" language="en_US">
<since><version>14.0.0</version></since>
<synopsis>
Return caller at the specified position in a queue.
</synopsis>
@@ -772,6 +784,7 @@
</see-also>
</function>
<function name="QUEUE_WAITING_COUNT" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Count number of calls currently waiting in a queue.
</synopsis>
@@ -799,6 +812,7 @@
</see-also>
</function>
<function name="QUEUE_MEMBER_LIST" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Returns a list of interfaces on a queue.
</synopsis>
@@ -826,6 +840,7 @@
</see-also>
</function>
<function name="QUEUE_MEMBER_PENALTY" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Gets or sets queue members penalty.
</synopsis>