kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-09-23 14:44:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Add version information to application and function XML elements

Browse Source 
* 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
Download Patch File Download Diff File Expand all files Collapse all files

2
funcs/func_aes.c
View File

@@ -39,6 +39,7 @@
/*** DOCUMENTATION
<function name="AES_ENCRYPT" language="en_US">
<since><version>1.6.1.0</version></since>
<synopsis>
Encrypt a string with AES given a 16 character key.
</synopsis>
@@ -60,6 +61,7 @@
</see-also>
</function>
<function name="AES_DECRYPT" language="en_US">
<since><version>1.6.1.0</version></since>
<synopsis>
Decrypt a string encoded in base64 with AES given a 16 character key.
</synopsis>

2
funcs/func_base64.c
View File

@@ -35,6 +35,7 @@
/*** DOCUMENTATION
<function name="BASE64_ENCODE" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Encode a string in base64.
</synopsis>
@@ -53,6 +54,7 @@
</see-also>
</function>
<function name="BASE64_DECODE" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Decode a base64 string.
</synopsis>

1
funcs/func_blacklist.c
View File

@@ -39,6 +39,7 @@
/*** DOCUMENTATION
<function name="BLACKLIST" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Check if the callerid is on the blacklist.
</synopsis>

1
funcs/func_callcompletion.c
View File

@@ -34,6 +34,7 @@
/*** DOCUMENTATION
<function name="CALLCOMPLETION" language="en_US">
<since><version>1.8.0</version></since>
<synopsis>
Get or set a call completion configuration parameter for a channel.
</synopsis>

3
funcs/func_callerid.c
View File

@@ -70,6 +70,7 @@
*/
/*** DOCUMENTATION
<function name="CALLERID" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Gets or sets Caller*ID data on the channel.
</synopsis>
@@ -202,6 +203,7 @@
</description>
</function>
<function name="CONNECTEDLINE" language="en_US">
<since><version>1.8.0</version></since>
<synopsis>
Gets or sets Connected Line data on the channel.
</synopsis>
@@ -299,6 +301,7 @@
</description>
</function>
<function name="REDIRECTING" language="en_US">
<since><version>1.8.0</version></since>
<synopsis>
Gets or sets Redirecting data on the channel.
</synopsis>

2
funcs/func_cdr.c
View File

@@ -42,6 +42,7 @@
/*** DOCUMENTATION
<function name="CDR" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Gets or sets a CDR variable.
</synopsis>
@@ -167,6 +168,7 @@
</description>
</function>
<function name="CDR_PROP" language="en_US">
<since><version>12.0.0</version></since>
<synopsis>
Set a property on a channel's CDR.
</synopsis>

4
funcs/func_channel.c
View File

@@ -49,6 +49,7 @@
/*** DOCUMENTATION
<function name="CHANNELS" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Gets the list of channels, optionally filtering by a regular expression.
</synopsis>
@@ -67,7 +68,6 @@
<since>
<version>16.22.0</version>
<version>18.8.0</version>
<version>19.0.0</version>
</since>
<synopsis>
Checks if the specified channel exists.
@@ -82,6 +82,7 @@
</description>
</function>
<function name="MASTER_CHANNEL" language="en_US">
<since><version>1.8.0</version></since>
<synopsis>
Gets or sets variables on the master channel
</synopsis>
@@ -94,6 +95,7 @@
</description>
</function>
<function name="CHANNEL" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Gets/sets various pieces of information about the channel.
</synopsis>

1
funcs/func_config.c
View File

@@ -40,6 +40,7 @@
/*** DOCUMENTATION
<function name="AST_CONFIG" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Retrieve a variable from a configuration file.
</synopsis>

2
funcs/func_curl.c
View File

@@ -53,6 +53,7 @@
/*** DOCUMENTATION
<function name="CURL" language="en_US">
<since><version>10.0.0</version></since>
<synopsis>
Retrieve content from a remote web or ftp server
</synopsis>
@@ -95,6 +96,7 @@
</see-also>
</function>
<function name="CURLOPT" language="en_US">
<since><version>10.0.0</version></since>
<synopsis>
Sets various options for future invocations of CURL.
</synopsis>

2
funcs/func_cut.c
View File

@@ -38,6 +38,7 @@
/*** DOCUMENTATION
<function name="SORT" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Sorts a list of key/vals into a list of keys, based upon the vals.
</synopsis>
@@ -58,6 +59,7 @@
</description>
</function>
<function name="CUT" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Slices and dices strings, based upon a named delimiter.
</synopsis>

5
funcs/func_db.c
View File

@@ -44,6 +44,7 @@
/*** DOCUMENTATION
<function name="DB" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Read from or write to the Asterisk database.
</synopsis>
@@ -66,6 +67,7 @@
</see-also>
</function>
<function name="DB_EXISTS" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Check to see if a key exists in the Asterisk database.
</synopsis>
@@ -84,6 +86,7 @@
</see-also>
</function>
<function name="DB_KEYS" language="en_US">
<since><version>10.0.0</version></since>
<synopsis>
Obtain a list of keys within the Asterisk database.
</synopsis>
@@ -100,6 +103,7 @@
</see-also>
</function>
<function name="DB_KEYCOUNT" language="en_US">
<since><version>16.26.0</version><version>18.12.0</version><version>19.4.0</version></since>
<synopsis>
Obtain the number of keys at a prefix within the Asterisk database.
</synopsis>
@@ -116,6 +120,7 @@
</see-also>
</function>
<function name="DB_DELETE" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Return a value from the database and delete it.
</synopsis>

2
funcs/func_devstate.c
View File

@@ -48,6 +48,7 @@
/*** DOCUMENTATION
<function name="DEVICE_STATE" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Get or Set a device state.
</synopsis>
@@ -72,6 +73,7 @@
</description>
</function>
<function name="HINT" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Get the devices set for a dialplan hint.
</synopsis>

1
funcs/func_dialgroup.c
View File

@@ -43,6 +43,7 @@
/*** DOCUMENTATION
<function name="DIALGROUP" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Manages a group of users for dialing.
</synopsis>

2
funcs/func_dialplan.c
View File

@@ -37,6 +37,7 @@
/*** DOCUMENTATION
<function name="DIALPLAN_EXISTS" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Checks the existence of a dialplan target.
</synopsis>
@@ -50,6 +51,7 @@
</description>
</function>
<function name="VALID_EXTEN" language="en_US">
<since><version>11.0.0</version></since>
<synopsis>
Determine whether an extension exists or not.
</synopsis>

4
funcs/func_enum.c
View File

@@ -50,6 +50,7 @@
/*** DOCUMENTATION
<function name="ENUMQUERY" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Initiate an ENUM query.
</synopsis>
@@ -69,6 +70,7 @@
</description>
</function>
<function name="ENUMRESULT" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Retrieve results from a ENUMQUERY.
</synopsis>
@@ -89,6 +91,7 @@
</description>
</function>
<function name="ENUMLOOKUP" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
General or specific querying of NAPTR records for ENUM or ENUM-like DNS pointers.
</synopsis>
@@ -133,6 +136,7 @@
</description>
</function>
<function name="TXTCIDNAME" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
TXTCIDNAME looks up a caller name via DNS.
</synopsis>

7
funcs/func_env.c
View File

@@ -39,6 +39,7 @@
/*** DOCUMENTATION
<function name="ENV" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Gets or sets the environment variable specified.
</synopsis>
@@ -101,6 +102,7 @@
</description>
</function>
<function name="STAT" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Does a check on the specified file.
</synopsis>
@@ -127,6 +129,7 @@
</description>
</function>
<function name="FILE" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Read or write text file.
</synopsis>
@@ -245,6 +248,7 @@
</see-also>
</function>
<function name="FILE_COUNT_LINE" language="en_US">
<since><version>1.8.0</version></since>
<synopsis>
Obtains the number of lines of a text file.
</synopsis>
@@ -280,6 +284,7 @@
</see-also>
</function>
<function name="FILE_FORMAT" language="en_US">
<since><version>1.8.0</version></since>
<synopsis>
Return the newline format of a text file.
</synopsis>
@@ -307,7 +312,6 @@
<since>
<version>16.21.0</version>
<version>18.7.0</version>
<version>19.0.0</version>
</since>
<synopsis>
Return the name of a file.
@@ -330,7 +334,6 @@
<since>
<version>16.21.0</version>
<version>18.7.0</version>
<version>19.0.0</version>
</since>
<synopsis>
Return the directory of a file.

2
funcs/func_evalexten.c
View File

@@ -37,6 +37,7 @@
/*** DOCUMENTATION
<function name="EVAL_EXTEN" language="en_US">
<since><version>16.26.0</version><version>18.12.0</version><version>19.4.0</version></since>
<synopsis>
Evaluates the contents of a dialplan extension and returns it as a string.
</synopsis>
@@ -90,6 +91,7 @@
</see-also>
</function>
<function name="EVAL_SUB" language="en_US">
<since><version>20.11.0</version><version>21.6.0</version><version>22.1.0</version></since>
<synopsis>
Executes a Gosub and provides its return value as a string
</synopsis>

1
funcs/func_export.c
View File

@@ -38,6 +38,7 @@
/*** DOCUMENTATION
<function name="EXPORT" language="en_US">
<since><version>16.30.0</version><version>18.16.0</version><version>19.8.0</version><version>20.1.0</version></since>
<synopsis>
Set variables or dialplan functions on any arbitrary channel that exists.
</synopsis>

1
funcs/func_extstate.c
View File

@@ -40,6 +40,7 @@
/*** DOCUMENTATION
<function name="EXTENSION_STATE" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Get an extension's state.
</synopsis>

1
funcs/func_frame_drop.c
View File

@@ -41,7 +41,6 @@
<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.

1
funcs/func_frame_trace.c
View File

@@ -39,6 +39,7 @@
/*** DOCUMENTATION
<function name="FRAME_TRACE" language="en_US">
<since><version>10.0.0</version></since>
<synopsis>
View internal ast_frames as they are read and written on a channel.
</synopsis>

4
funcs/func_global.c
View File

@@ -41,6 +41,7 @@
/*** DOCUMENTATION
<function name="GLOBAL" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Gets or sets the global variable specified.
</synopsis>
@@ -54,6 +55,7 @@
</description>
</function>
<function name="GLOBAL_DELETE" language="en_US">
<since><version>18.21.0</version><version>20.6.0</version><version>21.1.0</version></since>
<synopsis>
Deletes a specified global variable.
</synopsis>
@@ -72,6 +74,7 @@
</see-also>
</function>
<function name="GLOBAL_EXISTS" language="en_US">
<since><version>18.21.0</version><version>20.6.0</version><version>21.1.0</version></since>
<synopsis>
Check if a global variable exists or not.
</synopsis>
@@ -88,6 +91,7 @@
</see-also>
</function>
<function name="SHARED" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Gets or sets the shared variable specified.
</synopsis>

4
funcs/func_groupcount.c
View File

@@ -35,6 +35,7 @@
/*** DOCUMENTATION
<function name="GROUP_COUNT" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Counts the number of channels in the specified group.
</synopsis>
@@ -52,6 +53,7 @@
</description>
</function>
<function name="GROUP_MATCH_COUNT" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Counts the number of channels in the groups matching the specified pattern.
</synopsis>
@@ -70,6 +72,7 @@
</description>
</function>
<function name="GROUP" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Gets or sets the channel group.
</synopsis>
@@ -84,6 +87,7 @@
</description>
</function>
<function name="GROUP_LIST" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Gets a list of the groups set on a channel.
</synopsis>

3
funcs/func_hangupcause.c
View File

@@ -41,6 +41,7 @@
/*** DOCUMENTATION
<function name="HANGUPCAUSE" language="en_US">
<since><version>11.0.0</version></since>
<synopsis>
Gets per-channel hangupcause information from the channel.
</synopsis>
@@ -66,6 +67,7 @@
</see-also>
</function>
<function name="HANGUPCAUSE_KEYS" language="en_US">
<since><version>11.0.0</version></since>
<synopsis>
Gets the list of channels for which hangup causes are available.
</synopsis>
@@ -78,6 +80,7 @@
</see-also>
</function>
<application name="HangupCauseClear" language="en_US">
<since><version>11.0.0</version></since>
<synopsis>
Clears hangup cause information from the channel that is available through HANGUPCAUSE.
</synopsis>

1
funcs/func_holdintercept.c
View File

@@ -41,6 +41,7 @@
/*** DOCUMENTATION
<function name="HOLD_INTERCEPT" language="en_US">
<since><version>13.7.0</version></since>
<synopsis>
Intercepts hold frames on a channel and raises an event instead of passing the frame on
</synopsis>

1
funcs/func_iconv.c
View File

@@ -42,6 +42,7 @@
/*** DOCUMENTATION
<function name="ICONV" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Converts charsets of strings.
</synopsis>

1
funcs/func_jitterbuffer.c
View File

@@ -42,6 +42,7 @@
/*** DOCUMENTATION
<function name="JITTERBUFFER" language="en_US">
<since><version>10.0.0</version></since>
<synopsis>
Add a Jitterbuffer to the Read side of the channel. This dejitters the audio stream before it reaches the Asterisk core. This is a write only function.
</synopsis>

3
funcs/func_lock.c
View File

@@ -46,6 +46,7 @@
/*** DOCUMENTATION
<function name="LOCK" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Attempt to obtain a named mutex.
</synopsis>
@@ -70,6 +71,7 @@
</see-also>
</function>
<function name="TRYLOCK" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Attempt to obtain a named mutex.
</synopsis>
@@ -92,6 +94,7 @@
</see-also>
</function>
<function name="UNLOCK" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Unlocks a named mutex.
</synopsis>

8
funcs/func_logic.c
View File

@@ -38,6 +38,7 @@
/*** DOCUMENTATION
<function name="ISNULL" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Check if a value is NULL.
</synopsis>
@@ -49,6 +50,7 @@
</description>
</function>
<function name="SET" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
SET assigns a value to a channel variable.
</synopsis>
@@ -60,6 +62,7 @@
</description>
</function>
<function name="EXISTS" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Test the existence of a value.
</synopsis>
@@ -71,6 +74,7 @@
</description>
</function>
<function name="IF" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Check for an expression.
</synopsis>
@@ -86,6 +90,7 @@
</description>
</function>
<function name="IFTIME" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Temporal Conditional.
</synopsis>
@@ -101,6 +106,7 @@
</description>
</function>
<function name="IMPORT" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Retrieve the value of a variable from another channel.
</synopsis>
@@ -112,6 +118,7 @@
</description>
</function>
<function name="DELETE" language="en_US">
<since><version>18.21.0</version><version>20.6.0</version><version>21.1.0</version></since>
<synopsis>
Deletes a specified channel variable.
</synopsis>
@@ -129,6 +136,7 @@
</see-also>
</function>
<function name="VARIABLE_EXISTS" language="en_US">
<since><version>18.21.0</version><version>20.6.0</version><version>21.1.0</version></since>
<synopsis>
Check if a dialplan variable exists or not.
</synopsis>

6
funcs/func_math.c
View File

@@ -49,6 +49,7 @@
/*** DOCUMENTATION
<function name="MATH" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Performs Mathematical Functions.
</synopsis>
@@ -77,6 +78,7 @@
</description>
</function>
<function name="INC" language="en_US">
<since><version>1.8.0</version></since>
<synopsis>
Increments the value of a variable, while returning the updated value to the dialplan
</synopsis>
@@ -94,6 +96,7 @@
</description>
</function>
<function name="DEC" language="en_US">
<since><version>1.8.0</version></since>
<synopsis>
Decrements the value of a variable, while returning the updated value to the dialplan
</synopsis>
@@ -116,7 +119,6 @@
<since>
<version>16.19.0</version>
<version>18.5.0</version>
<version>19.0.0</version>
</since>
<synopsis>
Returns the minimum of two numbers.
@@ -136,7 +138,6 @@
<since>
<version>16.19.0</version>
<version>18.5.0</version>
<version>19.0.0</version>
</since>
<synopsis>
Returns the maximum of two numbers.
@@ -156,7 +157,6 @@
<since>
<version>16.19.0</version>
<version>18.5.0</version>
<version>19.0.0</version>
</since>
<synopsis>
Returns absolute value of a number.

1
funcs/func_md5.c
View File

@@ -37,6 +37,7 @@
/*** DOCUMENTATION
<function name="MD5" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Computes an MD5 digest.
</synopsis>

1
funcs/func_module.c
View File

@@ -33,6 +33,7 @@
/*** DOCUMENTATION
<function name="IFMODULE" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Checks if an Asterisk module is loaded in memory.
</synopsis>

4
funcs/func_odbc.c
View File

@@ -48,6 +48,7 @@
/*** DOCUMENTATION
<function name="ODBC_FETCH" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Fetch a row from a multirow query.
</synopsis>
@@ -72,6 +73,7 @@
</description>
</function>
<application name="ODBCFinish" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Clear the resultset of a sucessful multirow query.
</synopsis>
@@ -84,6 +86,7 @@
</description>
</application>
<function name="SQL_ESC" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Escapes single ticks for use in SQL statements.
</synopsis>
@@ -99,6 +102,7 @@
</description>
</function>
<function name="SQL_ESC_BACKSLASHES" language="en_US">
<since><version>16.26.0</version><version>18.12.0</version><version>19.4.0</version></since>
<synopsis>
Escapes backslashes for use in SQL statements.
</synopsis>

1
funcs/func_periodic_hook.c
View File

@@ -46,6 +46,7 @@
/*** DOCUMENTATION
<function name="PERIODIC_HOOK" language="en_US">
<since><version>13.0.0</version></since>
<synopsis>
Execute a periodic dialplan hook into the audio of a call.
</synopsis>

1
funcs/func_pitchshift.c
View File

@@ -73,6 +73,7 @@
/*** DOCUMENTATION
<function name="PITCH_SHIFT" language="en_US">
<since><version>1.8.0</version></since>
<synopsis>
Pitch shift both tx and rx audio streams on a channel.
</synopsis>

1
funcs/func_pjsip_aor.c
View File

@@ -45,6 +45,7 @@
/*** DOCUMENTATION
<function name="PJSIP_AOR" language="en_US">
<since><version>13.2.0</version></since>
<synopsis>
Get information about a PJSIP AOR
</synopsis>

1
funcs/func_pjsip_contact.c
View File

@@ -45,6 +45,7 @@
/*** DOCUMENTATION
<function name="PJSIP_CONTACT" language="en_US">
<since><version>13.2.0</version></since>
<synopsis>
Get information about a PJSIP contact
</synopsis>

1
funcs/func_pjsip_endpoint.c
View File

@@ -46,6 +46,7 @@
/*** DOCUMENTATION
<function name="PJSIP_ENDPOINT" language="en_US">
<since><version>12.0.0</version></since>
<synopsis>
Get information about a PJSIP endpoint
</synopsis>

1
funcs/func_presencestate.c
View File

@@ -44,6 +44,7 @@
/*** DOCUMENTATION
<function name="PRESENCE_STATE" language="en_US">
<since><version>11.0.0</version></since>
<synopsis>
Get or Set a presence state.
</synopsis>

1
funcs/func_rand.c
View File

@@ -38,6 +38,7 @@
/*** DOCUMENTATION
<function name="RAND" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Choose a random number in a range.
</synopsis>

5
funcs/func_realtime.c
View File

@@ -41,6 +41,7 @@
/*** DOCUMENTATION
<function name="REALTIME" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
RealTime Read/Write Functions.
</synopsis>
@@ -77,6 +78,7 @@
</see-also>
</function>
<function name="REALTIME_STORE" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
RealTime Store Function.
</synopsis>
@@ -100,6 +102,7 @@
</see-also>
</function>
<function name="REALTIME_DESTROY" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
RealTime Destroy Function.
</synopsis>
@@ -128,6 +131,7 @@
</see-also>
</function>
<function name="REALTIME_FIELD" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
RealTime query function.
</synopsis>
@@ -151,6 +155,7 @@
</see-also>
</function>
<function name="REALTIME_HASH" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
RealTime query function.
</synopsis>

1
funcs/func_sayfiles.c
View File

@@ -45,7 +45,6 @@
<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).

1
funcs/func_scramble.c
View File

@@ -35,7 +35,6 @@
<since>
<version>16.21.0</version>
<version>18.7.0</version>
<version>19.0.0</version>
</since>
<synopsis>
Scrambles audio on a channel.

1
funcs/func_sha1.c
View File

@@ -35,6 +35,7 @@
/*** DOCUMENTATION
<function name="SHA1" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Computes a SHA1 digest.
</synopsis>

1
funcs/func_shell.c
View File

@@ -76,6 +76,7 @@ static int shell_helper(struct ast_channel *chan, const char *cmd, char *data,
/*** DOCUMENTATION
<function name="SHELL" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Executes a command using the system shell and captures its output.
</synopsis>

1
funcs/func_sorcery.c
View File

@@ -39,6 +39,7 @@
/*** DOCUMENTATION
<function name="AST_SORCERY" language="en_US">
<since><version>12.2.0</version></since>
<synopsis>
Get a field from a sorcery object
</synopsis>

2
funcs/func_speex.c
View File

@@ -50,6 +50,7 @@
/*** DOCUMENTATION
<function name="AGC" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Apply automatic gain control to audio on a channel.
</synopsis>
@@ -73,6 +74,7 @@
</description>
</function>
<function name="DENOISE" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Apply noise reduction to audio on a channel.
</synopsis>

1
funcs/func_sprintf.c
View File

@@ -43,6 +43,7 @@ AST_THREADSTORAGE(result_buf);
/*** DOCUMENTATION
<function name="SPRINTF" language="en_US">
<since><version>1.6.1.0</version></since>
<synopsis>
Format a variable according to a format string.
</synopsis>

2
funcs/func_srv.c
View File

@@ -38,6 +38,7 @@
/*** DOCUMENTATION
<function name="SRVQUERY" language="en_US">
<since><version>1.8.0</version></since>
<synopsis>
Initiate an SRV query.
</synopsis>
@@ -52,6 +53,7 @@
</description>
</function>
<function name="SRVRESULT" language="en_US">
<since><version>1.8.0</version></since>
<synopsis>
Retrieve results from an SRVQUERY.
</synopsis>

29
funcs/func_strings.c
View File

@@ -49,6 +49,7 @@ AST_THREADSTORAGE(tmp_buf);
/*** DOCUMENTATION
<function name="FIELDQTY" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Count the fields with an arbitrary delimiter
</synopsis>
@@ -69,6 +70,7 @@ AST_THREADSTORAGE(tmp_buf);
</description>
</function>
<function name="FIELDNUM" language="en_US">
<since><version>10.0.0</version></since>
<synopsis>
Return the 1-based offset of a field in a list
</synopsis>
@@ -93,6 +95,7 @@ AST_THREADSTORAGE(tmp_buf);
</description>
</function>
<function name="LISTFILTER" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>Remove an item from a list, by name.</synopsis>
<syntax>
<parameter name="varname" required="true" />
@@ -106,6 +109,7 @@ AST_THREADSTORAGE(tmp_buf);
</description>
</function>
<function name="FILTER" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Filter the string to include only the allowed characters
</synopsis>
@@ -125,6 +129,7 @@ AST_THREADSTORAGE(tmp_buf);
</description>
</function>
<function name="REPLACE" language="en_US">
<since><version>1.8.0</version></since>
<synopsis>
Replace a set of characters in a given string with another character.
</synopsis>
@@ -143,6 +148,7 @@ AST_THREADSTORAGE(tmp_buf);
</description>
</function>
<function name="STRREPLACE" language="en_US">
<since><version>10.0.0</version></since>
<synopsis>
Replace instances of a substring within a string with another string.
</synopsis>
@@ -164,7 +170,6 @@ AST_THREADSTORAGE(tmp_buf);
<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.
@@ -184,6 +189,7 @@ AST_THREADSTORAGE(tmp_buf);
</description>
</function>
<function name="TRIM" language="en_US">
<since><version>16.30.0</version><version>18.16.0</version><version>19.8.0</version><version>20.1.0</version></since>
<synopsis>
Trim leading and trailing whitespace in a string
</synopsis>
@@ -199,6 +205,7 @@ AST_THREADSTORAGE(tmp_buf);
</see-also>
</function>
<function name="LTRIM" language="en_US">
<since><version>16.30.0</version><version>18.16.0</version><version>19.8.0</version><version>20.1.0</version></since>
<synopsis>
Trim leading whitespace in a string
</synopsis>
@@ -214,6 +221,7 @@ AST_THREADSTORAGE(tmp_buf);
</see-also>
</function>
<function name="RTRIM" language="en_US">
<since><version>16.30.0</version><version>18.16.0</version><version>19.8.0</version><version>20.1.0</version></since>
<synopsis>
Trim trailing whitespace in a string
</synopsis>
@@ -229,6 +237,7 @@ AST_THREADSTORAGE(tmp_buf);
</see-also>
</function>
<function name="PASSTHRU" language="en_US">
<since><version>1.8.0</version></since>
<synopsis>
Pass the given argument back as a value.
</synopsis>
@@ -248,6 +257,7 @@ AST_THREADSTORAGE(tmp_buf);
</description>
</function>
<function name="REGEX" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Check string against a regular expression.
</synopsis>
@@ -264,6 +274,7 @@ AST_THREADSTORAGE(tmp_buf);
</description>
</function>
<application name="ClearHash" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Clear the keys from a specified hashname.
</synopsis>
@@ -275,6 +286,7 @@ AST_THREADSTORAGE(tmp_buf);
</description>
</application>
<function name="HASH" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Implementation of a dialplan associative array
</synopsis>
@@ -289,6 +301,7 @@ AST_THREADSTORAGE(tmp_buf);
</description>
</function>
<function name="HASHKEYS" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Retrieve the keys of the HASH() function.
</synopsis>
@@ -303,6 +316,7 @@ AST_THREADSTORAGE(tmp_buf);
</description>
</function>
<function name="KEYPADHASH" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Hash the letters in string into equivalent keypad numbers.
</synopsis>
@@ -316,6 +330,7 @@ AST_THREADSTORAGE(tmp_buf);
</description>
</function>
<function name="ARRAY" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Allows setting multiple variables at once.
</synopsis>
@@ -334,6 +349,7 @@ AST_THREADSTORAGE(tmp_buf);
</description>
</function>
<function name="STRPTIME" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Returns the epoch of the arbitrary date/time string structured as described by the format.
</synopsis>
@@ -352,6 +368,7 @@ AST_THREADSTORAGE(tmp_buf);
</description>
</function>
<function name="STRFTIME" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Returns the current date/time in the specified format.
</synopsis>
@@ -374,6 +391,7 @@ AST_THREADSTORAGE(tmp_buf);
</see-also>
</function>
<function name="EVAL" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Evaluate stored variables
</synopsis>
@@ -395,6 +413,7 @@ AST_THREADSTORAGE(tmp_buf);
</description>
</function>
<function name="TOUPPER" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Convert string to all uppercase letters.
</synopsis>
@@ -408,6 +427,7 @@ AST_THREADSTORAGE(tmp_buf);
</description>
</function>
<function name="TOLOWER" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Convert string to all lowercase letters.
</synopsis>
@@ -421,6 +441,7 @@ AST_THREADSTORAGE(tmp_buf);
</description>
</function>
<function name="LEN" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Return the length of the string given.
</synopsis>
@@ -434,6 +455,7 @@ AST_THREADSTORAGE(tmp_buf);
</description>
</function>
<function name="QUOTE" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Quotes a given string, escaping embedded quotes as necessary
</synopsis>
@@ -445,6 +467,7 @@ AST_THREADSTORAGE(tmp_buf);
</description>
</function>
<function name="CSV_QUOTE" language="en_US">
<since><version>1.8.0</version></since>
<synopsis>
Quotes a given string for use in a CSV file, escaping embedded quotes as necessary
</synopsis>
@@ -456,6 +479,7 @@ AST_THREADSTORAGE(tmp_buf);
</description>
</function>
<function name="SHIFT" language="en_US">
<since><version>1.8.0</version></since>
<synopsis>
Removes and returns the first item off of a variable containing delimited text
</synopsis>
@@ -477,6 +501,7 @@ AST_THREADSTORAGE(tmp_buf);
</description>
</function>
<function name="POP" language="en_US">
<since><version>1.8.0</version></since>
<synopsis>
Removes and returns the last item off of a variable containing delimited text
</synopsis>
@@ -498,6 +523,7 @@ AST_THREADSTORAGE(tmp_buf);
</description>
</function>
<function name="PUSH" language="en_US">
<since><version>1.8.0</version></since>
<synopsis>
Appends one or more values to the end of a variable containing delimited text
</synopsis>
@@ -516,6 +542,7 @@ AST_THREADSTORAGE(tmp_buf);
</description>
</function>
<function name="UNSHIFT" language="en_US">
<since><version>1.8.0</version></since>
<synopsis>
Inserts one or more values to the beginning of a variable containing delimited text
</synopsis>

1
funcs/func_sysinfo.c
View File

@@ -40,6 +40,7 @@
/*** DOCUMENTATION
<function name="SYSINFO" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Returns system information specified by parameter.
</synopsis>

1
funcs/func_timeout.c
View File

@@ -38,6 +38,7 @@
/*** DOCUMENTATION
<function name="TIMEOUT" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Gets or sets timeouts on the channel. Timeout values are in seconds.
</synopsis>

2
funcs/func_uri.c
View File

@@ -42,6 +42,7 @@
/*** DOCUMENTATION
<function name="URIENCODE" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Encodes a string to URI-safe encoding according to RFC 2396.
</synopsis>
@@ -55,6 +56,7 @@
</description>
</function>
<function name="URIDECODE" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Decodes a URI-encoded string according to RFC 2396.
</synopsis>

1
funcs/func_version.c
View File

@@ -38,6 +38,7 @@
/*** DOCUMENTATION
<function name="VERSION" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Return the Version info for this Asterisk.
</synopsis>

1
funcs/func_vmcount.c
View File

@@ -43,6 +43,7 @@
/*** DOCUMENTATION
<function name="VMCOUNT" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Count the voicemails in a specified mailbox or mailboxes.
</synopsis>

1
funcs/func_volume.c
View File

@@ -41,6 +41,7 @@
/*** DOCUMENTATION
<function name="VOLUME" language="en_US">
<since><version>1.6.2.0</version></since>
<synopsis>
Set or get the TX or RX volume of a channel.
</synopsis>