[Asterisk-code-review] documentation: Adds versioning information. (asterisk[18])

George Joseph asteriskteam at digium.com
Wed Apr 27 02:07:03 CDT 2022 

George Joseph has submitted this change. ( https://gerrit.asterisk.org/c/asterisk/+/18341 )

Change subject: documentation: Adds versioning information.
......................................................................

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
---
M apps/app_confbridge.c
M apps/app_dtmfstore.c
M apps/app_mf.c
M apps/app_sendtext.c
M apps/app_sf.c
M apps/app_waitforcond.c
M channels/pjsip/dialplan_functions.c
M funcs/func_channel.c
M funcs/func_env.c
M funcs/func_frame_drop.c
M funcs/func_json.c
M funcs/func_math.c
M funcs/func_sayfiles.c
M funcs/func_scramble.c
M funcs/func_strings.c
M funcs/func_talkdetect.c
M main/manager.c
M res/res_pjsip_header_funcs.c
M res/res_tonedetect.c
19 files changed, 145 insertions(+), 0 deletions(-)

Approvals:
  Joshua Colp: Looks good to me, but someone else must approve
  Kevin Harwell: Looks good to me, approved
  Benjamin Keith Ford: Looks good to me, but someone else must approve
  George Joseph: Approved for Submit



diff --git a/apps/app_confbridge.c b/apps/app_confbridge.c
index e0a0b4d..d811d64 100644
--- 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>
diff --git a/apps/app_dtmfstore.c b/apps/app_dtmfstore.c
index 641170f..a2dacd5 100644
--- 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>
diff --git a/apps/app_mf.c b/apps/app_mf.c
index eef5419..cd3320d 100644
--- 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>
diff --git a/apps/app_sendtext.c b/apps/app_sendtext.c
index 07e6acc..fd8774a 100644
--- 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>
diff --git a/apps/app_sf.c b/apps/app_sf.c
index 70f60d4..cd8f79a 100644
--- 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>
diff --git a/apps/app_waitforcond.c b/apps/app_waitforcond.c
index 725afc0..d20ebdb 100644
--- 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>
diff --git a/channels/pjsip/dialplan_functions.c b/channels/pjsip/dialplan_functions.c
index 176bc49..a433d07 100644
--- 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>
diff --git a/funcs/func_channel.c b/funcs/func_channel.c
index 49c4b05..c1c8e5b 100644
--- 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>
diff --git a/funcs/func_env.c b/funcs/func_env.c
index f5ff3e0..2602500 100644
--- 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>
diff --git a/funcs/func_frame_drop.c b/funcs/func_frame_drop.c
index c19c566..f5d70f3 100644
--- 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>
diff --git a/funcs/func_json.c b/funcs/func_json.c
index a48b85c..1f64824 100644
--- 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.
diff --git a/funcs/func_math.c b/funcs/func_math.c
index 76d1a74..c5c30e4 100644
--- 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>
diff --git a/funcs/func_sayfiles.c b/funcs/func_sayfiles.c
index 81f3259..d3f3341 100644
--- 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>
diff --git a/funcs/func_scramble.c b/funcs/func_scramble.c
index 01756d9..a90d7a2 100644
--- 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>
diff --git a/funcs/func_strings.c b/funcs/func_strings.c
index 28fe6e0..3eed847 100644
--- a/funcs/func_strings.c
+++ b/funcs/func_strings.c
@@ -155,6 +155,11 @@
 		</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>
diff --git a/funcs/func_talkdetect.c b/funcs/func_talkdetect.c
index 8453111..88c470e 100644
--- 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>
diff --git a/main/manager.c b/main/manager.c
index 4c55823..d834f04 100644
--- 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>
diff --git a/res/res_pjsip_header_funcs.c b/res/res_pjsip_header_funcs.c
index 794b5e8..ee94147 100644
--- 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>
diff --git a/res/res_tonedetect.c b/res/res_tonedetect.c
index 4943f69..45afe5b 100644
--- 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>

-- 
To view, visit https://gerrit.asterisk.org/c/asterisk/+/18341
To unsubscribe, or for help writing mail filters, visit https://gerrit.asterisk.org/settings

Gerrit-Project: asterisk
Gerrit-Branch: 18
Gerrit-Change-Id: I506401e93c799715dbbe97c0a8ba18af2bf5e131
Gerrit-Change-Number: 18341
Gerrit-PatchSet: 2
Gerrit-Owner: N A <mail at interlinked.x10host.com>
Gerrit-Reviewer: Benjamin Keith Ford <bford at digium.com>
Gerrit-Reviewer: Friendly Automation
Gerrit-Reviewer: George Joseph <gjoseph at digium.com>
Gerrit-Reviewer: Joshua Colp <jcolp at sangoma.com>
Gerrit-Reviewer: Kevin Harwell <kharwell at digium.com>
Gerrit-MessageType: merged
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.digium.com/pipermail/asterisk-code-review/attachments/20220427/756e578e/attachment-0001.html>

More information about the asterisk-code-review mailing list