kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-09-05 12:16:00 +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 N A
parent 1dce155f07
commit 6296f645a2
8 changed files with 78 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
apps/app_queue.c
View File

@@ -376,7 +376,9 @@
<value name="NOTDYNAMIC" />
</variable>
</variablelist>
<para>Example: RemoveQueueMember(techsupport,SIP/3000)</para>
<example title="Remove queue member">
same => n,RemoveQueueMember(techsupport,SIP/3000)
</example>
</description>
<see-also>
<ref type="application">Queue</ref>
@@ -421,7 +423,9 @@
<value name="NOTFOUND" />
</variable>
</variablelist>
<para>Example: PauseQueueMember(,SIP/3000)</para>
<example title="Pause queue member">
same => n,PauseQueueMember(,SIP/3000)
</example>
</description>
<see-also>
<ref type="application">Queue</ref>
@@ -463,7 +467,9 @@
<value name="NOTFOUND" />
</variable>
</variablelist>
<para>Example: UnpauseQueueMember(,SIP/3000)</para>
<example title="Unpause queue member">
same => n,UnpauseQueueMember(,SIP/3000)
</example>
</description>
<see-also>
<ref type="application">Queue</ref>
@@ -495,7 +501,9 @@
</syntax>
<description>
<para>Allows you to write your own events into the queue log.</para>
<para>Example: QueueLog(101,${UNIQUEID},${AGENT},WENTONBREAK,600)</para>
<example title="Log custom queue event">
same => n,QueueLog(101,${UNIQUEID},${AGENT},WENTONBREAK,600)
</example>
</description>
<see-also>
<ref type="application">Queue</ref>
@@ -516,7 +524,7 @@
</application>
<application name="QueueUpdate" language="en_US">
<synopsis>
Writes to the queue_log file for OutBound calls and updates Realtime Data.
Writes to the queue_log file for outbound calls and updates Realtime Data.
Is used at h extension to be able to have all the parameters.
</synopsis>
<syntax>
@@ -529,7 +537,9 @@
</syntax>
<description>
<para>Allows you to write Outbound events into the queue log.</para>
<para>Example: exten => h,1,QueueUpdate(${QUEUE}, ${UNIQUEID}, ${AGENT}, ${DIALSTATUS}, ${ANSWEREDTIME}, ${DIALEDTIME} | ${DIALEDNUMBER})</para>
<example title="Write outbound event into queue log">
exten => h,1,QueueUpdate(${QUEUE}, ${UNIQUEID}, ${AGENT}, ${DIALSTATUS}, ${ANSWEREDTIME}, ${DIALEDTIME} | ${DIALEDNUMBER})
</example>
</description>
</application>
<function name="QUEUE_VARIABLES" language="en_US">