From a1b0d3492a0209617e7a5540f651c1ffc28d4061 Mon Sep 17 00:00:00 2001 From: George Joseph Date: Fri, 24 Jan 2025 13:55:47 -0700 Subject: [PATCH] docs: Add version information to AGI command XML elements. 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 | 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. --- res/res_agi.c | 138 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 138 insertions(+) diff --git a/res/res_agi.c b/res/res_agi.c index 28045b19dd..815443b861 100644 --- a/res/res_agi.c +++ b/res/res_agi.c @@ -73,6 +73,9 @@ /*** DOCUMENTATION + + 0.4.0 + Answer channel @@ -87,6 +90,9 @@ + + 1.8.0 + Interrupts Async AGI @@ -101,6 +107,9 @@ + + 0.4.0 + Returns status of the connected channel. @@ -143,6 +152,9 @@ + + 1.2.0 + Sends audio file on channel and allows the listener to control the stream. @@ -198,6 +210,9 @@ + + 0.4.0 + Removes database key/value @@ -219,6 +234,9 @@ + + 0.4.0 + Removes database keytree/value @@ -239,6 +257,9 @@ + + 0.4.0 + Gets database value @@ -262,6 +283,9 @@ + + 0.4.0 + Adds/updates database value @@ -284,6 +308,9 @@ + + 0.4.0 + Executes a given Application @@ -305,6 +332,9 @@ + + 0.4.0 + Prompts for DTMF on a channel @@ -322,6 +352,9 @@ + + 1.2.0 + Evaluates a channel expression @@ -349,6 +382,9 @@ + + 1.2.0 + Stream file, prompt for DTMF, with timeout. @@ -367,6 +403,9 @@ + + 0.4.0 + Gets a channel variable. @@ -386,6 +425,9 @@ + + 0.4.0 + Hangup a channel. @@ -401,6 +443,9 @@ + + 0.4.0 + Does nothing. @@ -413,6 +458,9 @@ + + 0.4.0 + Receives one character from channels supporting it. @@ -434,6 +482,9 @@ + + 1.2.0 + Receives text from channels supporting it. @@ -455,6 +506,9 @@ + + 0.4.0 + Records to a given file. @@ -506,6 +560,9 @@ + + 1.2.0 + Says a given character string. @@ -530,6 +587,9 @@ + + 0.4.0 + Says a given digit string. @@ -554,6 +614,9 @@ + + 0.4.0 + Says a given number. @@ -579,6 +642,9 @@ + + 1.0.0 + Says a given character string with phonetics. @@ -603,6 +669,9 @@ + + 1.2.0 + Says a given date. @@ -630,6 +699,9 @@ + + 1.0.0 + Says a given time. @@ -657,6 +729,9 @@ + + 1.2.0 + Says a given time as specified by the format given. @@ -693,6 +768,9 @@ + + 0.4.0 + Sends images to channels supporting it. @@ -710,6 +788,9 @@ + + 0.4.0 + Sends text to channels supporting it. @@ -731,6 +812,9 @@ + + 0.4.0 + Autohangup channel in some time. @@ -747,6 +831,9 @@ + + 0.4.0 + Sets callerid for the current channel. @@ -761,6 +848,9 @@ + + 0.4.0 + Sets channel context. @@ -777,6 +867,9 @@ + + 0.4.0 + Changes channel extension. @@ -793,6 +886,9 @@ + + 0.5.0 + Enable/Disable Music on hold generator @@ -816,6 +912,9 @@ + + 0.4.0 + Set channel dialplan priority. @@ -833,6 +932,9 @@ + + 0.4.0 + Sets a channel variable. @@ -850,6 +952,9 @@ + + 0.4.0 + Sends audio file on channel. @@ -890,6 +995,9 @@ + + 0.4.0 + Toggles TDD mode (for the deaf). @@ -910,6 +1018,9 @@ + + 0.4.0 + Logs a message to the asterisk verbose log. @@ -927,6 +1038,9 @@ + + 0.4.0 + Waits for a digit to be pressed. @@ -945,6 +1059,9 @@ + + 1.6.0 + Creates a speech object. @@ -966,6 +1083,9 @@ + + 1.6.0 + Sets a speech engine setting. @@ -988,6 +1108,9 @@ + + 1.6.0 + Destroys a speech object. @@ -1008,6 +1131,9 @@ + + 1.6.0 + Loads a grammar. @@ -1030,6 +1156,9 @@ + + 1.6.0 + Unloads a grammar. @@ -1051,6 +1180,9 @@ + + 1.6.0 + Activates a grammar. @@ -1072,6 +1204,9 @@ + + 1.6.0 + Deactivates a grammar. @@ -1093,6 +1228,9 @@ + + 1.6.0 + Recognizes speech.