kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-09-03 11:25:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

documentation: Standardize examples

Browse Source 
Most examples in the XML documentation use the
example tag to demonstrate examples, which gets
parsed specially in the Wiki to make it easier
to follow for users.

This fixes a few modules to use the example
tag instead of vanilla para tags to bring them
in line with the standard syntax.

ASTERISK-29777 #close

Change-Id: I9acb6cc5faf1d220e73c6dd28592371d768d279b
This commit is contained in:
Naveen Albert
2021-11-25 18:41:18 +00:00
committed by Friendly Automation
parent 2478bfcff9
commit 24a04054ad
8 changed files with 78 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
res/res_agi.c
View File

@@ -1185,21 +1185,17 @@
after a channel hangup is detected, set the <variable>AGIEXITONHANGUP</variable>
variable to <literal>yes</literal>.</para>
</note>
<example title="AGI invocation examples">
; Start the AGI script /tmp/my-cool-script.sh, passing it the contents
; of the channel variable FOO
same => n,AGI(/tmp/my-cool-script.sh,${FOO})
; Start the AGI script my-cool-script.sh located in the astagidir
; directory, specified in asterisk.conf
same => n,AGI(my-cool-script.sh)
; Connect to the FastAGI server located at 127.0.0.1 and start the script
; awesome-script
same => n,AGI(agi://127.0.0.1/awesome-script)
; Start AsyncAGI
same => n,AGI(agi:async)
<example title="Start the AGI script /tmp/my-cool-script.sh, passing it the contents of the channel variable FOO">
same => n,AGI(/tmp/my-cool-script.sh,${FOO})
</example>
<example title="Start the AGI script my-cool-script.sh located in the astagidir directory, specified in asterisk.conf">
same => n,AGI(my-cool-script.sh)
</example>
<example title="Connect to the FastAGI server located at 127.0.0.1 and start the script awesome-script">
same => n,AGI(agi://127.0.0.1/awesome-script)
</example>
<example title="Start AsyncAGI">
same => n,AGI(agi:async)
</example>
<para>This application sets the following channel variable upon completion:</para>
<variablelist>