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

docs: Add version information to configObject and configOption XML elements

Browse Source 
Most of the configObjects and configOptions that are implemented with
ACO or Sorcery now have `<since>/<version>` elements added.  There are
probably some that the script I used didn't catch.  The version tags were
determined by the following...
 * Do a git blame on the API call that created the object or option.
 * 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 <major>.<minor>.0.
 * Sort and discard any <major>.0.0 and following tags where the commit
   appeared in an earlier branch.
 * The result is a single tag for each branch where the API was last touched.

configObjects and configOptions elements implemented with the base
ast_config APIs were just not possible to find due to the non-deterministic
way they are accessed.

Also note that if the API call was on modified after it was added, the
version will be the one it was last modified in.

Final note:  The configObject and configOption elements were introduced in
12.0.0 so options created before then may not have any XML documentation.
This commit is contained in:
George Joseph
2025-01-16 14:54:35 -07:00
committed by asterisk-org-access-app[bot]
parent 0c272429e6
commit f70670841b
31 changed files with 649 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
main/features_config.c
View File

@@ -33,24 +33,31 @@
<synopsis>Features Configuration</synopsis>
<configFile name="features.conf">
<configObject name="globals">
<since><version>12.0.0</version></since>
<synopsis>
</synopsis>
<configOption name="featuredigittimeout" default="1000">
<since><version>12.0.0</version></since>
<synopsis>Milliseconds allowed between digit presses when entering a feature code.</synopsis>
</configOption>
<configOption name="courtesytone">
<since><version>12.0.0</version></since>
<synopsis>Sound to play when automon or automixmon is activated</synopsis>
</configOption>
<configOption name="recordingfailsound">
<since><version>12.0.0</version></since>
<synopsis>Sound to play when automon or automixmon is attempted but fails to start</synopsis>
</configOption>
<configOption name="transferdigittimeout" default="3">
<since><version>12.0.0</version></since>
<synopsis>Seconds allowed between digit presses when dialing a transfer destination</synopsis>
</configOption>
<configOption name="atxfernoanswertimeout" default="15">
<since><version>12.0.0</version></since>
<synopsis>Seconds to wait for attended transfer destination to answer</synopsis>
</configOption>
<configOption name="atxferdropcall" default="no">
<since><version>12.0.0</version></since>
<synopsis>Hang up the call entirely if the attended transfer fails</synopsis>
<description>
<para>When this option is set to <literal>no</literal>, then Asterisk will attempt to
@@ -65,14 +72,17 @@
</description>
</configOption>
<configOption name="atxferloopdelay" default="10">
<since><version>12.0.0</version></since>
<synopsis>Seconds to wait between attempts to re-dial transfer destination</synopsis>
<see-also><ref type="configOption">atxferdropcall</ref></see-also>
</configOption>
<configOption name="atxfercallbackretries" default="2">
<since><version>12.0.0</version></since>
<synopsis>Number of times to re-attempt dialing a transfer destination</synopsis>
<see-also><ref type="configOption">atxferdropcall</ref></see-also>
</configOption>
<configOption name="xfersound" default="beep">
<since><version>12.0.0</version></since>
<synopsis>Sound to play to during transfer and transfer-like operations.</synopsis>
<description>
<para>This sound will play to the transferrer and transfer target channels when
@@ -81,6 +91,7 @@
</description>
</configOption>
<configOption name="xferfailsound" default="beeperr">
<since><version>12.0.0</version></since>
<synopsis>Sound to play to a transferee when a transfer fails</synopsis>
</configOption>
<configOption name="atxferabort" default="*1">
@@ -129,27 +140,35 @@
</description>
</configOption>
<configOption name="pickupsound">
<since><version>12.0.0</version></since>
<synopsis>Sound to play to picker when a call is picked up</synopsis>
</configOption>
<configOption name="pickupfailsound">
<since><version>12.0.0</version></since>
<synopsis>Sound to play to picker when a call cannot be picked up</synopsis>
</configOption>
<configOption name="transferdialattempts" default="3">
<since><version>13.1.0</version></since>
<synopsis>Number of dial attempts allowed when attempting a transfer</synopsis>
</configOption>
<configOption name="transferretrysound" default="pbx-invalid">
<since><version>13.1.0</version></since>
<synopsis>Sound that is played when an incorrect extension is dialed and the transferer should try again.</synopsis>
</configOption>
<configOption name="transferinvalidsound" default="privacy-incorrect">
<since><version>13.1.0</version></since>
<synopsis>Sound that is played when an incorrect extension is dialed and the transferer has no attempts remaining.</synopsis>
</configOption>
<configOption name="transferannouncesound" default="pbx-transfer">
<since><version>16.29.0</version><version>18.15.0</version><version>19.7.0</version></since>
<synopsis>Sound that is played to the transferer when a transfer is initiated. If empty, no sound will be played.</synopsis>
</configOption>
</configObject>
<configObject name="featuremap">
<since><version>12.0.0</version></since>
<synopsis>DTMF options that can be triggered during bridged calls</synopsis>
<configOption name="atxfer">
<since><version>12.0.0</version></since>
<synopsis>DTMF sequence to initiate an attended transfer</synopsis>
<description>
<para>The transferee parties will be placed on hold and the
@@ -161,6 +180,7 @@
</description>
</configOption>
<configOption name="blindxfer" default="#">
<since><version>12.0.0</version></since>
<synopsis>DTMF sequence to initiate a blind transfer</synopsis>
<description>
<para>The transferee parties will be placed on hold and the
@@ -177,6 +197,7 @@
</description>
</configOption>
<configOption name="parkcall">
<since><version>12.0.0</version></since>
<synopsis>DTMF sequence to park a call</synopsis>
<description>
<para>The parking lot used to park the call is determined by using either the
@@ -206,6 +227,7 @@
<see-also><ref type="configOption">automixmon</ref></see-also>
</configOption>
<configOption name="automixmon">
<since><version>12.0.0</version></since>
<synopsis>DTMF sequence to start or stop MixMonitor on a call</synopsis>
<description>
<para>This will cause the channel that pressed the DTMF sequence
@@ -226,6 +248,7 @@
</configOption>
</configObject>
<configObject name="applicationmap">
<since><version>12.0.0</version></since>
<synopsis>Section for defining custom feature invocations during a call</synopsis>
<description>
<para>The applicationmap is an area where new custom features can be created. Items
@@ -278,6 +301,7 @@
</configOption>
</configObject>
<configObject name="featuregroup">
<since><version>12.0.0</version></since>
<synopsis>Groupings of items from the applicationmap</synopsis>
<description>
<para>Feature groups allow for multiple applicationmap items to be