kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-09-04 20:04:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

xmldocs: Improve examples.

Browse Source 
Use example tags instead of regular para tags
where possible.

ASTERISK-30090

Change-Id: Iada8bbfda08f30b118cedf2d040bbb21e4966ec5
This commit is contained in:
Naveen Albert
2022-06-01 01:43:52 +00:00
committed by Friendly Automation
parent e92f047e5f
commit 7f892d03a5
23 changed files with 353 additions and 243 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
funcs/func_periodic_hook.c
View File

@@ -67,15 +67,15 @@
<para>For example, you could use this function to enable playing
a periodic <literal>beep</literal> sound in a call.</para>
<para/>
<para>To turn on:</para>
<para> Set(BEEPID=${PERIODIC_HOOK(hooks,beep,180)})</para>
<para/>
<para>To turn off:</para>
<para> Set(PERIODIC_HOOK(${BEEPID})=off)</para>
<para/>
<para>To turn back on again later:</para>
<para>Set(PERIODIC_HOOK(${BEEPID})=on)</para>
<para/>
<example title="To turn on">
same => n,Set(BEEPID=${PERIODIC_HOOK(hooks,beep,180)})
</example>
<example title="To turn off">
same => n,Set(PERIODIC_HOOK(${BEEPID})=off)
</example>
<example title="To turn back on again later">
same => n,Set(PERIODIC_HOOK(${BEEPID})=on)
</example>
<para>It is important to note that the hook does not actually
run on the channel itself. It runs asynchronously on a new channel.
Any audio generated by the hook gets injected into the call for