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 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

View File

@@ -42,6 +42,7 @@
/*** DOCUMENTATION
<application name="SpeechCreate" language="en_US">
<since><version>1.6.1.0</version></since>
<synopsis>
Create a Speech Structure.
</synopsis>
@@ -56,6 +57,7 @@
</description>
</application>
<application name="SpeechActivateGrammar" language="en_US">
<since><version>1.6.1.0</version></since>
<synopsis>
Activate a grammar.
</synopsis>
@@ -70,6 +72,7 @@
</description>
</application>
<application name="SpeechStart" language="en_US">
<since><version>1.6.1.0</version></since>
<synopsis>
Start recognizing voice in the audio stream.
</synopsis>
@@ -81,6 +84,7 @@
</description>
</application>
<application name="SpeechBackground" language="en_US">
<since><version>1.6.1.0</version></since>
<synopsis>
Play a sound file and wait for speech to be recognized.
</synopsis>
@@ -124,6 +128,7 @@
</description>
</application>
<application name="SpeechDeactivateGrammar" language="en_US">
<since><version>1.6.1.0</version></since>
<synopsis>
Deactivate a grammar.
</synopsis>
@@ -138,6 +143,7 @@
</description>
</application>
<application name="SpeechProcessingSound" language="en_US">
<since><version>1.6.1.0</version></since>
<synopsis>
Change background processing sound.
</synopsis>
@@ -151,6 +157,7 @@
</description>
</application>
<application name="SpeechDestroy" language="en_US">
<since><version>1.6.1.0</version></since>
<synopsis>
End speech recognition.
</synopsis>
@@ -163,6 +170,7 @@
</description>
</application>
<application name="SpeechLoadGrammar" language="en_US">
<since><version>1.6.1.0</version></since>
<synopsis>
Load a grammar.
</synopsis>
@@ -176,6 +184,7 @@
</description>
</application>
<application name="SpeechUnloadGrammar" language="en_US">
<since><version>1.6.1.0</version></since>
<synopsis>
Unload a grammar.
</synopsis>
@@ -188,6 +197,7 @@
</description>
</application>
<function name="SPEECH_SCORE" language="en_US">
<since><version>1.6.1.0</version></since>
<synopsis>
Gets the confidence score of a result.
</synopsis>
@@ -200,6 +210,7 @@
</description>
</function>
<function name="SPEECH_TEXT" language="en_US">
<since><version>1.6.1.0</version></since>
<synopsis>
Gets the recognized text of a result.
</synopsis>
@@ -212,6 +223,7 @@
</description>
</function>
<function name="SPEECH_GRAMMAR" language="en_US">
<since><version>1.6.1.0</version></since>
<synopsis>
Gets the matched grammar of a result if available.
</synopsis>
@@ -224,6 +236,7 @@
</description>
</function>
<function name="SPEECH_ENGINE" language="en_US">
<since><version>1.6.1.0</version></since>
<synopsis>
Get or change a speech engine specific attribute.
</synopsis>
@@ -235,6 +248,7 @@
</description>
</function>
<function name="SPEECH_RESULTS_TYPE" language="en_US">
<since><version>1.6.1.0</version></since>
<synopsis>
Sets the type of results that will be returned.
</synopsis>
@@ -244,6 +258,7 @@
</description>
</function>
<function name="SPEECH" language="en_US">
<since><version>1.6.1.0</version></since>
<synopsis>
Gets information about speech recognition results.
</synopsis>