kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-10-22 04:43:50 +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

17
apps/app_waitforsilence.c
View File

@@ -23,9 +23,6 @@
*
* \brief Wait for Silence
* - Waits for up to 'x' milliseconds of silence, 'y' times \n
* - WaitForSilence(500,2) will wait for 1/2 second of silence, twice \n
* - WaitForSilence(1000,1) will wait for 1 second of silence, once \n
* - WaitForSilence(300,3,10) will wait for 300ms of silence, 3 times, and return after 10sec \n
*
* \author David C. Troy <dave@popvox.com>
*
@@ -78,11 +75,15 @@
playing a message.</para>
<para>Typically you will want to include two or more calls to WaitForSilence when dealing with an answering
machine; first waiting for the spiel to finish, then waiting for the beep, etc.</para>
<para>Examples:</para>
<para>WaitForSilence(500,2) will wait for 1/2 second of silence, twice</para>
<para>WaitForSilence(1000) will wait for 1 second of silence, once</para>
<para>WaitForSilence(300,3,10) will wait for 300ms silence, 3 times, and returns after 10 sec, even if silence
is not detected</para>
<example title="Wait for half a second of silence, twice">
same => n,WaitForSilence(500,2)
</example>
<example title="Wait for one second of silence, once">
same => n,WaitForSilence(1000)
</example>
<example title="Wait for 300 ms of silence, 3 times, and returns after 10 seconds, even if no silence detected">
same => n,WaitForSilence(300,3,10)
</example>
<para>Sets the channel variable <variable>WAITSTATUS</variable> to one of these values:</para>
<variablelist>
<variable name="WAITSTATUS">