documentation: Adds versioning information.

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
4 years ago · bbc27f835b
parent a3e7b2d010
commit bbc27f835b
19 changed files with 145 additions and 0 deletions
--- a/apps/app_confbridge.c
+++ b/apps/app_confbridge.c
@ -131,6 +131,11 @@
 		</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>
--- a/apps/app_dtmfstore.c
+++ b/apps/app_dtmfstore.c
@ -41,6 +41,11 @@

 /*** 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>
--- a/apps/app_mf.c
+++ b/apps/app_mf.c
@ -42,6 +42,11 @@

 /*** 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>
@ -113,6 +118,11 @@
 		</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>
@ -151,6 +161,11 @@
 		</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>
--- a/apps/app_sendtext.c
+++ b/apps/app_sendtext.c
@ -145,6 +145,11 @@
 		</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>
--- a/apps/app_sf.c
+++ b/apps/app_sf.c
@ -42,6 +42,11 @@

 /*** 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>
@ -107,6 +112,11 @@
 		</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>
--- a/apps/app_waitforcond.c
+++ b/apps/app_waitforcond.c
@ -39,6 +39,11 @@

 /*** 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>
--- a/channels/pjsip/dialplan_functions.c
+++ b/channels/pjsip/dialplan_functions.c
@ -69,6 +69,12 @@
 	</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>
@ -94,6 +100,11 @@
 	</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>
@ -135,6 +146,11 @@
 	</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>
--- a/funcs/func_channel.c
+++ b/funcs/func_channel.c
@ -64,6 +64,11 @@
 		</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>
--- a/funcs/func_env.c
+++ b/funcs/func_env.c
@ -291,6 +291,11 @@
 		</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>
@ -309,6 +314,11 @@
 		</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>
--- a/funcs/func_frame_drop.c
+++ b/funcs/func_frame_drop.c
@ -38,6 +38,11 @@

 /*** 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>
--- a/funcs/func_json.c
+++ b/funcs/func_json.c
@ -39,6 +39,11 @@

 /*** 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.
--- a/funcs/func_math.c
+++ b/funcs/func_math.c
@ -109,6 +109,11 @@
 		</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>
@ -123,6 +128,11 @@
 		</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>
@ -137,6 +147,11 @@
 		</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>
--- a/funcs/func_sayfiles.c
+++ b/funcs/func_sayfiles.c
@ -42,6 +42,11 @@

 /*** 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>
--- a/funcs/func_scramble.c
+++ b/funcs/func_scramble.c
@ -32,6 +32,11 @@

 /*** 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>
--- a/funcs/func_strings.c
+++ b/funcs/func_strings.c
@ -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>
--- a/funcs/func_talkdetect.c
+++ b/funcs/func_talkdetect.c
@ -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>
--- a/main/manager.c
+++ b/main/manager.c
@ -633,6 +633,12 @@
 		</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>
--- a/res/res_pjsip_header_funcs.c
+++ b/res/res_pjsip_header_funcs.c
@ -146,6 +146,11 @@
 		</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>
--- a/res/res_tonedetect.c
+++ b/res/res_tonedetect.c
@ -46,6 +46,11 @@

 /*** 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>
@ -94,6 +99,11 @@
 		</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>
@ -169,6 +179,11 @@
 		</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>