Asterisk
/
asterisk
mirror of https://github.com/asterisk/asterisk
1
0
Fork 0
Code Issues Releases Wiki Activity

docs: Add version information to AGI command XML elements.

Browse Source 
This process was a bit different than the others because everything
is in the same file, there's an array that contains the command
names and their handler functions, and the last command was created
over 15 years ago.

* Dump a `git blame` of res/res_agi.c from BEFORE the handle_* prototypes
  were changed.
* Create a command <> handler function xref by parsing the the agi_command
  array.
* For each entry, grep the function definition line "static int handle_*"
  from the git blame output and capture the commit.  This will be the
  commit the command was created in.
* Do a `git tag --contains <commit> | sort -V | head -1` to get the
  tag the function was created in.
* Add a single since/version element to the command XML.  Multiple versions
  aren't supported here because the branching and tagging scheme changed
  several times in the 2000's.
pull/1145/head
George Joseph 3 months ago
parent 575545b49c
commit a1b0d3492a
1 changed files with 138 additions and 0 deletions
Show Stats Download Patch File Download Diff File

138
res/res_agi.c
Unescape View File

@ -73,6 +73,9 @@
/*** DOCUMENTATION /*** DOCUMENTATION
<agi name="answer" language="en_US"> <agi name="answer" language="en_US">
<since>
<version>0.4.0</version>
</since>
<synopsis> <synopsis>
Answer channel Answer channel
</synopsis> </synopsis>
@ -87,6 +90,9 @@
</see-also> </see-also>
</agi> </agi>
<agi name="asyncagi break" language="en_US"> <agi name="asyncagi break" language="en_US">
<since>
<version>1.8.0</version>
</since>
<synopsis> <synopsis>
Interrupts Async AGI Interrupts Async AGI
</synopsis> </synopsis>
@ -101,6 +107,9 @@
</see-also> </see-also>
</agi> </agi>
<agi name="channel status" language="en_US"> <agi name="channel status" language="en_US">
<since>
<version>0.4.0</version>
</since>
<synopsis> <synopsis>
Returns status of the connected channel. Returns status of the connected channel.
</synopsis> </synopsis>
@ -143,6 +152,9 @@
</see-also> </see-also>
</agi> </agi>
<agi name="control stream file" language="en_US"> <agi name="control stream file" language="en_US">
<since>
<version>1.2.0</version>
</since>
<synopsis> <synopsis>
Sends audio file on channel and allows the listener to control the stream. Sends audio file on channel and allows the listener to control the stream.
</synopsis> </synopsis>
@ -198,6 +210,9 @@
</see-also> </see-also>
</agi> </agi>
<agi name="database del" language="en_US"> <agi name="database del" language="en_US">
<since>
<version>0.4.0</version>
</since>
<synopsis> <synopsis>
Removes database key/value Removes database key/value
</synopsis> </synopsis>
@ -219,6 +234,9 @@
</see-also> </see-also>
</agi> </agi>
<agi name="database deltree" language="en_US"> <agi name="database deltree" language="en_US">
<since>
<version>0.4.0</version>
</since>
<synopsis> <synopsis>
Removes database keytree/value Removes database keytree/value
</synopsis> </synopsis>
@ -239,6 +257,9 @@
</see-also> </see-also>
</agi> </agi>
<agi name="database get" language="en_US"> <agi name="database get" language="en_US">
<since>
<version>0.4.0</version>
</since>
<synopsis> <synopsis>
Gets database value Gets database value
</synopsis> </synopsis>
@ -262,6 +283,9 @@
</see-also> </see-also>
</agi> </agi>
<agi name="database put" language="en_US"> <agi name="database put" language="en_US">
<since>
<version>0.4.0</version>
</since>
<synopsis> <synopsis>
Adds/updates database value Adds/updates database value
</synopsis> </synopsis>
@ -284,6 +308,9 @@
</see-also> </see-also>
</agi> </agi>
<agi name="exec" language="en_US"> <agi name="exec" language="en_US">
<since>
<version>0.4.0</version>
</since>
<synopsis> <synopsis>
Executes a given Application Executes a given Application
</synopsis> </synopsis>
@ -305,6 +332,9 @@
</see-also> </see-also>
</agi> </agi>
<agi name="get data" language="en_US"> <agi name="get data" language="en_US">
<since>
<version>0.4.0</version>
</since>
<synopsis> <synopsis>
Prompts for DTMF on a channel Prompts for DTMF on a channel
</synopsis> </synopsis>
@ -322,6 +352,9 @@
</see-also> </see-also>
</agi> </agi>
<agi name="get full variable" language="en_US"> <agi name="get full variable" language="en_US">
<since>
<version>1.2.0</version>
</since>
<synopsis> <synopsis>
Evaluates a channel expression Evaluates a channel expression
</synopsis> </synopsis>
@ -349,6 +382,9 @@
</see-also> </see-also>
</agi> </agi>
<agi name="get option" language="en_US"> <agi name="get option" language="en_US">
<since>
<version>1.2.0</version>
</since>
<synopsis> <synopsis>
Stream file, prompt for DTMF, with timeout. Stream file, prompt for DTMF, with timeout.
</synopsis> </synopsis>
@ -367,6 +403,9 @@
</see-also> </see-also>
</agi> </agi>
<agi name="get variable" language="en_US"> <agi name="get variable" language="en_US">
<since>
<version>0.4.0</version>
</since>
<synopsis> <synopsis>
Gets a channel variable. Gets a channel variable.
</synopsis> </synopsis>
@ -386,6 +425,9 @@
</see-also> </see-also>
</agi> </agi>
<agi name="hangup" language="en_US"> <agi name="hangup" language="en_US">
<since>
<version>0.4.0</version>
</since>
<synopsis> <synopsis>
Hangup a channel. Hangup a channel.
</synopsis> </synopsis>
@ -401,6 +443,9 @@
</see-also> </see-also>
</agi> </agi>
<agi name="noop" language="en_US"> <agi name="noop" language="en_US">
<since>
<version>0.4.0</version>
</since>
<synopsis> <synopsis>
Does nothing. Does nothing.
</synopsis> </synopsis>
@ -413,6 +458,9 @@
</see-also> </see-also>
</agi> </agi>
<agi name="receive char" language="en_US"> <agi name="receive char" language="en_US">
<since>
<version>0.4.0</version>
</since>
<synopsis> <synopsis>
Receives one character from channels supporting it. Receives one character from channels supporting it.
</synopsis> </synopsis>
@ -434,6 +482,9 @@
</see-also> </see-also>
</agi> </agi>
<agi name="receive text" language="en_US"> <agi name="receive text" language="en_US">
<since>
<version>1.2.0</version>
</since>
<synopsis> <synopsis>
Receives text from channels supporting it. Receives text from channels supporting it.
</synopsis> </synopsis>
@ -455,6 +506,9 @@
</see-also> </see-also>
</agi> </agi>
<agi name="record file" language="en_US"> <agi name="record file" language="en_US">
<since>
<version>0.4.0</version>
</since>
<synopsis> <synopsis>
Records to a given file. Records to a given file.
</synopsis> </synopsis>
@ -506,6 +560,9 @@
</see-also> </see-also>
</agi> </agi>
<agi name="say alpha" language="en_US"> <agi name="say alpha" language="en_US">
<since>
<version>1.2.0</version>
</since>
<synopsis> <synopsis>
Says a given character string. Says a given character string.
</synopsis> </synopsis>
@ -530,6 +587,9 @@
</see-also> </see-also>
</agi> </agi>
<agi name="say digits" language="en_US"> <agi name="say digits" language="en_US">
<since>
<version>0.4.0</version>
</since>
<synopsis> <synopsis>
Says a given digit string. Says a given digit string.
</synopsis> </synopsis>
@ -554,6 +614,9 @@
</see-also> </see-also>
</agi> </agi>
<agi name="say number" language="en_US"> <agi name="say number" language="en_US">
<since>
<version>0.4.0</version>
</since>
<synopsis> <synopsis>
Says a given number. Says a given number.
</synopsis> </synopsis>
@ -579,6 +642,9 @@
</see-also> </see-also>
</agi> </agi>
<agi name="say phonetic" language="en_US"> <agi name="say phonetic" language="en_US">
<since>
<version>1.0.0</version>
</since>
<synopsis> <synopsis>
Says a given character string with phonetics. Says a given character string with phonetics.
</synopsis> </synopsis>
@ -603,6 +669,9 @@
</see-also> </see-also>
</agi> </agi>
<agi name="say date" language="en_US"> <agi name="say date" language="en_US">
<since>
<version>1.2.0</version>
</since>
<synopsis> <synopsis>
Says a given date. Says a given date.
</synopsis> </synopsis>
@ -630,6 +699,9 @@
</see-also> </see-also>
</agi> </agi>
<agi name="say time" language="en_US"> <agi name="say time" language="en_US">
<since>
<version>1.0.0</version>
</since>
<synopsis> <synopsis>
Says a given time. Says a given time.
</synopsis> </synopsis>
@ -657,6 +729,9 @@
</see-also> </see-also>
</agi> </agi>
<agi name="say datetime" language="en_US"> <agi name="say datetime" language="en_US">
<since>
<version>1.2.0</version>
</since>
<synopsis> <synopsis>
Says a given time as specified by the format given. Says a given time as specified by the format given.
</synopsis> </synopsis>
@ -693,6 +768,9 @@
</see-also> </see-also>
</agi> </agi>
<agi name="send image" language="en_US"> <agi name="send image" language="en_US">
<since>
<version>0.4.0</version>
</since>
<synopsis> <synopsis>
Sends images to channels supporting it. Sends images to channels supporting it.
</synopsis> </synopsis>
@ -710,6 +788,9 @@
</see-also> </see-also>
</agi> </agi>
<agi name="send text" language="en_US"> <agi name="send text" language="en_US">
<since>
<version>0.4.0</version>
</since>
<synopsis> <synopsis>
Sends text to channels supporting it. Sends text to channels supporting it.
</synopsis> </synopsis>
@ -731,6 +812,9 @@
</see-also> </see-also>
</agi> </agi>
<agi name="set autohangup" language="en_US"> <agi name="set autohangup" language="en_US">
<since>
<version>0.4.0</version>
</since>
<synopsis> <synopsis>
Autohangup channel in some time. Autohangup channel in some time.
</synopsis> </synopsis>
@ -747,6 +831,9 @@
</see-also> </see-also>
</agi> </agi>
<agi name="set callerid" language="en_US"> <agi name="set callerid" language="en_US">
<since>
<version>0.4.0</version>
</since>
<synopsis> <synopsis>
Sets callerid for the current channel. Sets callerid for the current channel.
</synopsis> </synopsis>
@ -761,6 +848,9 @@
</see-also> </see-also>
</agi> </agi>
<agi name="set context" language="en_US"> <agi name="set context" language="en_US">
<since>
<version>0.4.0</version>
</since>
<synopsis> <synopsis>
Sets channel context. Sets channel context.
</synopsis> </synopsis>
@ -777,6 +867,9 @@
</see-also> </see-also>
</agi> </agi>
<agi name="set extension" language="en_US"> <agi name="set extension" language="en_US">
<since>
<version>0.4.0</version>
</since>
<synopsis> <synopsis>
Changes channel extension. Changes channel extension.
</synopsis> </synopsis>
@ -793,6 +886,9 @@
</see-also> </see-also>
</agi> </agi>
<agi name="set music" language="en_US"> <agi name="set music" language="en_US">
<since>
<version>0.5.0</version>
</since>
<synopsis> <synopsis>
Enable/Disable Music on hold generator Enable/Disable Music on hold generator
</synopsis> </synopsis>
@ -816,6 +912,9 @@
</see-also> </see-also>
</agi> </agi>
<agi name="set priority" language="en_US"> <agi name="set priority" language="en_US">
<since>
<version>0.4.0</version>
</since>
<synopsis> <synopsis>
Set channel dialplan priority. Set channel dialplan priority.
</synopsis> </synopsis>
@ -833,6 +932,9 @@
</see-also> </see-also>
</agi> </agi>
<agi name="set variable" language="en_US"> <agi name="set variable" language="en_US">
<since>
<version>0.4.0</version>
</since>
<synopsis> <synopsis>
Sets a channel variable. Sets a channel variable.
</synopsis> </synopsis>
@ -850,6 +952,9 @@
</see-also> </see-also>
</agi> </agi>
<agi name="stream file" language="en_US"> <agi name="stream file" language="en_US">
<since>
<version>0.4.0</version>
</since>
<synopsis> <synopsis>
Sends audio file on channel. Sends audio file on channel.
</synopsis> </synopsis>
@ -890,6 +995,9 @@
</see-also> </see-also>
</agi> </agi>
<agi name="tdd mode" language="en_US"> <agi name="tdd mode" language="en_US">
<since>
<version>0.4.0</version>
</since>
<synopsis> <synopsis>
Toggles TDD mode (for the deaf). Toggles TDD mode (for the deaf).
</synopsis> </synopsis>
@ -910,6 +1018,9 @@
</see-also> </see-also>
</agi> </agi>
<agi name="verbose" language="en_US"> <agi name="verbose" language="en_US">
<since>
<version>0.4.0</version>
</since>
<synopsis> <synopsis>
Logs a message to the asterisk verbose log. Logs a message to the asterisk verbose log.
</synopsis> </synopsis>
@ -927,6 +1038,9 @@
</see-also> </see-also>
</agi> </agi>
<agi name="wait for digit" language="en_US"> <agi name="wait for digit" language="en_US">
<since>
<version>0.4.0</version>
</since>
<synopsis> <synopsis>
Waits for a digit to be pressed. Waits for a digit to be pressed.
</synopsis> </synopsis>
@ -945,6 +1059,9 @@
</see-also> </see-also>
</agi> </agi>
<agi name="speech create" language="en_US"> <agi name="speech create" language="en_US">
<since>
<version>1.6.0</version>
</since>
<synopsis> <synopsis>
Creates a speech object. Creates a speech object.
</synopsis> </synopsis>
@ -966,6 +1083,9 @@
</see-also> </see-also>
</agi> </agi>
<agi name="speech set" language="en_US"> <agi name="speech set" language="en_US">
<since>
<version>1.6.0</version>
</since>
<synopsis> <synopsis>
Sets a speech engine setting. Sets a speech engine setting.
</synopsis> </synopsis>
@ -988,6 +1108,9 @@
</see-also> </see-also>
</agi> </agi>
<agi name="speech destroy" language="en_US"> <agi name="speech destroy" language="en_US">
<since>
<version>1.6.0</version>
</since>
<synopsis> <synopsis>
Destroys a speech object. Destroys a speech object.
</synopsis> </synopsis>
@ -1008,6 +1131,9 @@
</see-also> </see-also>
</agi> </agi>
<agi name="speech load grammar" language="en_US"> <agi name="speech load grammar" language="en_US">
<since>
<version>1.6.0</version>
</since>
<synopsis> <synopsis>
Loads a grammar. Loads a grammar.
</synopsis> </synopsis>
@ -1030,6 +1156,9 @@
</see-also> </see-also>
</agi> </agi>
<agi name="speech unload grammar" language="en_US"> <agi name="speech unload grammar" language="en_US">
<since>
<version>1.6.0</version>
</since>
<synopsis> <synopsis>
Unloads a grammar. Unloads a grammar.
</synopsis> </synopsis>
@ -1051,6 +1180,9 @@
</see-also> </see-also>
</agi> </agi>
<agi name="speech activate grammar" language="en_US"> <agi name="speech activate grammar" language="en_US">
<since>
<version>1.6.0</version>
</since>
<synopsis> <synopsis>
Activates a grammar. Activates a grammar.
</synopsis> </synopsis>
@ -1072,6 +1204,9 @@
</see-also> </see-also>
</agi> </agi>
<agi name="speech deactivate grammar" language="en_US"> <agi name="speech deactivate grammar" language="en_US">
<since>
<version>1.6.0</version>
</since>
<synopsis> <synopsis>
Deactivates a grammar. Deactivates a grammar.
</synopsis> </synopsis>
@ -1093,6 +1228,9 @@
</see-also> </see-also>
</agi> </agi>
<agi name="speech recognize" language="en_US"> <agi name="speech recognize" language="en_US">
<since>
<version>1.6.0</version>
</since>
<synopsis> <synopsis>
Recognizes speech. Recognizes speech.
</synopsis> </synopsis>

Write Preview
Loading…
Cancel
Save