]> git.ipfire.org Git - thirdparty/asterisk.git/commitdiff
documentation: Adds versioning information.
authorNaveen Albert <asterisk@phreaknet.org>
Fri, 25 Feb 2022 20:58:52 +0000 (20:58 +0000)
committerGeorge Joseph <gjoseph@digium.com>
Wed, 27 Apr 2022 07:06:35 +0000 (02:06 -0500)
Adds version information for applications, functions,
and manager events/actions.

This is not completely exhaustive by any means but
covers most new things added that have release
versioning information in the issue tracker.

ASTERISK-29940 #close

Change-Id: I506401e93c799715dbbe97c0a8ba18af2bf5e131

19 files changed:
apps/app_confbridge.c
apps/app_dtmfstore.c
apps/app_mf.c
apps/app_sendtext.c
apps/app_sf.c
apps/app_waitforcond.c
channels/pjsip/dialplan_functions.c
funcs/func_channel.c
funcs/func_env.c
funcs/func_frame_drop.c
funcs/func_json.c
funcs/func_math.c
funcs/func_sayfiles.c
funcs/func_scramble.c
funcs/func_strings.c
funcs/func_talkdetect.c
main/manager.c
res/res_pjsip_header_funcs.c
res/res_tonedetect.c

index e0a0b4da5d4d04d2bbcd9f828b6dd3678e9af5b4..d811d64264ebfac5bb03d9c713b576bcef4ab57c 100644 (file)
                </see-also>
        </application>
        <application name="ConfKick" language="en_US">
+               <since>
+                       <version>16.19.0</version>
+                       <version>18.5.0</version>
+                       <version>19.0.0</version>
+               </since>
                <synopsis>
                        Kicks channel(s) from the requested ConfBridge.
                </synopsis>
index 641170f1934ac6c8517deaac247d61e8774a1646..a2dacd54f7a1100857fa6878ec62a947f512721e 100644 (file)
 
 /*** DOCUMENTATION
        <application name="StoreDTMF" language="en_US">
+               <since>
+                       <version>16.20.0</version>
+                       <version>18.6.0</version>
+                       <version>19.0.0</version>
+               </since>
                <synopsis>
                        Stores DTMF digits transmitted or received on a channel.
                </synopsis>
index eef5419ce2c4b72bfeb38f9f5454f0dd9bacf3e4..cd3320d95c9ea7c118b2f62bc5a6ea9481c17084 100644 (file)
 
 /*** DOCUMENTATION
        <application name="ReceiveMF" language="en_US">
+               <since>
+                       <version>16.21.0</version>
+                       <version>18.7.0</version>
+                       <version>19.0.0</version>
+               </since>
                <synopsis>
                        Detects MF digits on a channel and saves them to a variable.
                </synopsis>
                </see-also>
        </application>
        <application name="SendMF" language="en_US">
+               <since>
+                       <version>16.21.0</version>
+                       <version>18.7.0</version>
+                       <version>19.0.0</version>
+               </since>
                <synopsis>
                        Sends arbitrary MF digits on the current or specified channel.
                </synopsis>
                </see-also>
        </application>
        <manager name="PlayMF" language="en_US">
+               <since>
+                       <version>16.21.0</version>
+                       <version>18.7.0</version>
+                       <version>19.0.0</version>
+               </since>
                <synopsis>
                        Play MF digit on a specific channel.
                </synopsis>
index 07e6accff95e293c14aa16a7ae0f82c0d8023d3a..fd8774a4773f48f7ec7d06dbb237fc43a791cea5 100644 (file)
                </see-also>
        </application>
        <application name="ReceiveText" language="en_US">
+               <since>
+                       <version>16.24.0</version>
+                       <version>18.10.0</version>
+                       <version>19.2.0</version>
+               </since>
                <synopsis>
                        Receive a Text Message on a channel.
                </synopsis>
index 70f60d41e515cbe75a1e540c97cd8c606d370690..cd8f79a6bc2cd966499017036eca60377b68a371 100644 (file)
 
 /*** DOCUMENTATION
        <application name="ReceiveSF" language="en_US">
+               <since>
+                       <version>16.24.0</version>
+                       <version>18.10.0</version>
+                       <version>19.2.0</version>
+               </since>
                <synopsis>
                        Detects SF digits on a channel and saves them to a variable.
                </synopsis>
                </see-also>
        </application>
        <application name="SendSF" language="en_US">
+               <since>
+                       <version>16.24.0</version>
+                       <version>18.10.0</version>
+                       <version>19.2.0</version>
+               </since>
                <synopsis>
                        Sends arbitrary SF digits on the current or specified channel.
                </synopsis>
index 725afc099a7699110ffcb4663a00dac286d67574..d20ebdb24a90bfd52306e12f9d637d47c662f637 100644 (file)
 
 /*** DOCUMENTATION
        <application name="WaitForCondition" language="en_US">
+               <since>
+                       <version>16.20.0</version>
+                       <version>18.6.0</version>
+                       <version>19.0.0</version>
+               </since>
                <synopsis>
                        Wait (sleep) until the given condition is true.
                </synopsis>
index 176bc496a8c5162eddcf41ee857857947f5b0fd4..a433d0734cd7994e7cada483eeb76b28de1b5089 100644 (file)
        </see-also>
 </function>
 <function name="PJSIP_DTMF_MODE" language="en_US">
+       <since>
+               <version>13.18.0</version>
+               <version>14.7.0</version>
+               <version>15.1.0</version>
+               <version>16.0.0</version>
+       </since>
        <synopsis>
                Get or change the DTMF mode for a SIP call.
        </synopsis>
        </description>
 </function>
 <function name="PJSIP_SEND_SESSION_REFRESH" language="en_US">
+       <since>
+               <version>13.12.0</version>
+               <version>14.1.0</version>
+               <version>15.0.0</version>
+       </since>
        <synopsis>
                W/O: Initiate a session refresh via an UPDATE or re-INVITE on an established media session
        </synopsis>
        </see-also>
 </function>
 <function name="PJSIP_PARSE_URI" language="en_US">
+       <since>
+               <version>13.24.0</version>
+               <version>16.1.0</version>
+               <version>17.0.0</version>
+       </since>
        <synopsis>
                Parse an uri and return a type part of the URI.
        </synopsis>
index 49c4b057793375667ad949815c5cabea5b42a32c..c1c8e5b71bdf165763d5e51dbe3b0300d62a5914 100644 (file)
                </description>
        </function>
        <function name="CHANNEL_EXISTS" language="en_US">
+               <since>
+                       <version>16.22.0</version>
+                       <version>18.8.0</version>
+                       <version>19.0.0</version>
+               </since>
                <synopsis>
                        Checks if the specified channel exists.
                </synopsis>
index f5ff3e0d3c7c45750ce01c03174b46736567d948..26025002ec6131a8eea08844d67f371d1321536f 100644 (file)
                </see-also>
        </function>
        <function name="BASENAME" language="en_US">
+               <since>
+                       <version>16.21.0</version>
+                       <version>18.7.0</version>
+                       <version>19.0.0</version>
+               </since>
                <synopsis>
                        Return the name of a file.
                </synopsis>
                </see-also>
        </function>
        <function name="DIRNAME" language="en_US">
+               <since>
+                       <version>16.21.0</version>
+                       <version>18.7.0</version>
+                       <version>19.0.0</version>
+               </since>
                <synopsis>
                        Return the directory of a file.
                </synopsis>
index c19c56680c6df9dc2dcbefff3cfa507e52d08ea1..f5d70f322a22f664e7c22ab7d51dabcf9ae396f6 100644 (file)
 
 /*** DOCUMENTATION
        <function name="FRAME_DROP" language="en_US">
+               <since>
+                       <version>16.21.0</version>
+                       <version>18.7.0</version>
+                       <version>19.0.0</version>
+               </since>
                <synopsis>
                        Drops specific frame types in the TX or RX direction on a channel.
                </synopsis>
index a48b85c663f94d8c82943d9f3e2d09f439740af8..1f6482428797c21389d74d432900d82e7fc2692d 100644 (file)
 
 /*** DOCUMENTATION
        <function name="JSON_DECODE" language="en_US">
+               <since>
+                       <version>16.24.0</version>
+                       <version>18.10.0</version>
+                       <version>19.2.0</version>
+               </since>
                <synopsis>
                        Returns the string value of a JSON object key from a string containing a
                        JSON array.
index 76d1a745fe4f6982e1715c61ee3fc59e00ca26f5..c5c30e4b6ec2bd6a5a7ba508d26f2290c6fa4a20 100644 (file)
                </description>
        </function>
        <function name="MIN" language="en_US">
+               <since>
+                       <version>16.19.0</version>
+                       <version>18.5.0</version>
+                       <version>19.0.0</version>
+               </since>
                <synopsis>
                        Returns the minimum of two numbers.
                </synopsis>
                </description>
        </function>
        <function name="MAX" language="en_US">
+               <since>
+                       <version>16.19.0</version>
+                       <version>18.5.0</version>
+                       <version>19.0.0</version>
+               </since>
                <synopsis>
                        Returns the maximum of two numbers.
                </synopsis>
                </description>
        </function>
        <function name="ABS" language="en_US">
+               <since>
+                       <version>16.19.0</version>
+                       <version>18.5.0</version>
+                       <version>19.0.0</version>
+               </since>
                <synopsis>
                        Returns absolute value of a number.
                </synopsis>
index 81f3259ad96bc5e9f022fce6955daa5ea209a199..d3f3341a4d5064fc06bc8ac8171565933d666ac6 100644 (file)
 
 /*** DOCUMENTATION
        <function name="SAYFILES" language="en_US">
+               <since>
+                       <version>16.21.0</version>
+                       <version>18.7.0</version>
+                       <version>19.0.0</version>
+               </since>
                <synopsis>
                        Returns the ampersand-delimited file names that would be played by the Say applications (e.g. SayAlpha, SayDigits).
                </synopsis>
index 01756d9a021b37b221439a13ba7069c23bb357cc..a90d7a277403552825ab0bc8e53bfd7142fa704d 100644 (file)
 
 /*** DOCUMENTATION
        <function name="SCRAMBLE" language="en_US">
+               <since>
+                       <version>16.21.0</version>
+                       <version>18.7.0</version>
+                       <version>19.0.0</version>
+               </since>
                <synopsis>
                        Scrambles audio on a channel.
                </synopsis>
index 28fe6e0b5befda256fffcaf6fd86881035021478..3eed847d54706434dce063c77cc964d3cb0da228 100644 (file)
@@ -155,6 +155,11 @@ AST_THREADSTORAGE(tmp_buf);
                </description>
        </function>
        <function name="STRBETWEEN" language="en_US">
+               <since>
+                       <version>16.21.0</version>
+                       <version>18.7.0</version>
+                       <version>19.0.0</version>
+               </since>
                <synopsis>
                        Inserts a substring between each character in a string.
                </synopsis>
index 8453111dd203b9cf85c58fc24c246d0bf4e61a7b..88c470e8e35d7f27afce24b0763388f9e950bdb7 100644 (file)
@@ -42,6 +42,9 @@
 
 /*** DOCUMENTATION
        <function name="TALK_DETECT" language="en_US">
+               <since>
+                       <version>12.4.0</version>
+               </since>
                <synopsis>
                        Raises notifications when Asterisk detects silence or talking on a channel.
                </synopsis>
index 4c55823a77c34050703812bf560c35d4fc6397f9..d834f0409993e88451850a766e9194767d5908b3 100644 (file)
                </see-also>
        </manager>
        <manager name="CancelAtxfer" language="en_US">
+               <since>
+                       <version>13.18.0</version>
+                       <version>14.7.0</version>
+                       <version>15.1.0</version>
+                       <version>16.0.0</version>
+               </since>
                <synopsis>
                        Cancel an attended transfer.
                </synopsis>
index 794b5e8c4b42ddabf0058fae8b8b768e3236e0c7..ee941479d72a6a79d74e5290cd78f57bc8c6ba0a 100644 (file)
                </description>
        </function>
        <function name="PJSIP_HEADERS" language="en_US">
+               <since>
+                       <version>16.20.0</version>
+                       <version>18.6.0</version>
+                       <version>19.0.0</version>
+               </since>
                <synopsis>
                        Gets the list of SIP header names from an INVITE message.
                </synopsis>
index 4943f69fdc1686fa9538c5d0ba41420e0017b89e..45afe5b084dfe00172e4261719ba9696d3705ef1 100644 (file)
 
 /*** DOCUMENTATION
        <application name="WaitForTone" language="en_US">
+               <since>
+                       <version>16.21.0</version>
+                       <version>18.7.0</version>
+                       <version>19.0.0</version>
+               </since>
                <synopsis>
                        Wait for tone
                </synopsis>
                </see-also>
        </application>
        <application name="ToneScan" language="en_US">
+               <since>
+                       <version>16.23.0</version>
+                       <version>18.9.0</version>
+                       <version>19.1.0</version>
+               </since>
                <synopsis>
                        Wait for period of time while scanning for call progress tones
                </synopsis>
                </see-also>
        </application>
        <function name="TONE_DETECT" language="en_US">
+               <since>
+                       <version>16.21.0</version>
+                       <version>18.7.0</version>
+                       <version>19.0.0</version>
+               </since>
                <synopsis>
                        Asynchronously detects a tone
                </synopsis>