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

docs: Indent <since> tags.

Browse Source 
Also updates the 'since' of applications/functions that existed before
XML documentation was introduced (1.6.2.0).
This commit is contained in:
Sean Bright
2025-01-23 16:35:58 -05:00
parent 5c3b35bc79
commit b4156fecf0
210 changed files with 4020 additions and 1208 deletions
Download Patch File Download Diff File Expand all files Collapse all files

128
apps/app_queue.c
View File

@@ -123,7 +123,9 @@
/*** DOCUMENTATION
<application name="Queue" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>0.2.0</version>
</since>
<synopsis>
Queue a call for a call queue.
</synopsis>
@@ -317,7 +319,9 @@
</see-also>
</application>
<application name="AddQueueMember" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>0.5.0</version>
</since>
<synopsis>
Dynamically adds queue members.
</synopsis>
@@ -371,7 +375,9 @@
</see-also>
</application>
<application name="RemoveQueueMember" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>0.5.0</version>
</since>
<synopsis>
Dynamically removes queue members.
</synopsis>
@@ -412,7 +418,9 @@
</see-also>
</application>
<application name="PauseQueueMember" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.2.0</version>
</since>
<synopsis>
Pauses a queue member.
</synopsis>
@@ -460,7 +468,9 @@
</see-also>
</application>
<application name="UnpauseQueueMember" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.2.0</version>
</since>
<synopsis>
Unpauses a queue member.
</synopsis>
@@ -505,7 +515,9 @@
</see-also>
</application>
<application name="QueueLog" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.4.0</version>
</since>
<synopsis>
Writes to the queue_log file.
</synopsis>
@@ -540,7 +552,9 @@
</see-also>
</application>
<application name="QueueUpdate" language="en_US">
<since><version>15.0.0</version></since>
<since>
<version>15.0.0</version>
</since>
<synopsis>
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.
@@ -561,7 +575,9 @@
</description>
</application>
<function name="QUEUE_VARIABLES" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.6.0</version>
</since>
<synopsis>
Return Queue information in variables.
</synopsis>
@@ -617,7 +633,9 @@
</see-also>
</function>
<function name="QUEUE_MEMBER" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.6.0</version>
</since>
<synopsis>
Provides a count of queue members based on the provided criteria, or updates a
queue member's settings.
@@ -683,7 +701,9 @@
</see-also>
</function>
<function name="QUEUE_MEMBER_COUNT" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.4.0</version>
</since>
<synopsis>
Count number of members answering a queue.
</synopsis>
@@ -712,7 +732,9 @@
</see-also>
</function>
<function name="QUEUE_EXISTS" language="en_US">
<since><version>1.8.0</version></since>
<since>
<version>1.8.0</version>
</since>
<synopsis>
Check if a named queue exists on this server
</synopsis>
@@ -740,7 +762,9 @@
</see-also>
</function>
<function name="QUEUE_GET_CHANNEL" language="en_US">
<since><version>14.0.0</version></since>
<since>
<version>14.0.0</version>
</since>
<synopsis>
Return caller at the specified position in a queue.
</synopsis>
@@ -769,7 +793,9 @@
</see-also>
</function>
<function name="QUEUE_WAITING_COUNT" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.4.0</version>
</since>
<synopsis>
Count number of calls currently waiting in a queue.
</synopsis>
@@ -797,7 +823,9 @@
</see-also>
</function>
<function name="QUEUE_MEMBER_LIST" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.4.0</version>
</since>
<synopsis>
Returns a list of interfaces on a queue.
</synopsis>
@@ -825,7 +853,9 @@
</see-also>
</function>
<function name="QUEUE_MEMBER_PENALTY" language="en_US">
<since><version>1.6.2.0</version></since>
<since>
<version>1.6.0</version>
</since>
<synopsis>
Gets or sets queue members penalty.
</synopsis>
@@ -1149,7 +1179,11 @@
<managerEvent language="en_US" name="QueueParams">
<managerEventInstance class="EVENT_FLAG_AGENT">
<since><version>16.24.0</version><version>18.10.0</version><version>19.2.0</version></since>
<since>
<version>16.24.0</version>
<version>18.10.0</version>
<version>19.2.0</version>
</since>
<synopsis>Raised in response to the QueueStatus action.</synopsis>
<syntax>
<parameter name="Max">
@@ -1188,7 +1222,11 @@
</managerEvent>
<managerEvent language="en_US" name="QueueEntry">
<managerEventInstance class="EVENT_FLAG_AGENT">
<since><version>16.24.0</version><version>18.10.0</version><version>19.2.0</version></since>
<since>
<version>16.24.0</version>
<version>18.10.0</version>
<version>19.2.0</version>
</since>
<synopsis>Raised in response to the QueueStatus action.</synopsis>
<syntax>
<parameter name="Queue">
@@ -1230,7 +1268,9 @@
</managerEvent>
<managerEvent language="en_US" name="QueueMemberStatus">
<managerEventInstance class="EVENT_FLAG_AGENT">
<since><version>12.0.0</version></since>
<since>
<version>12.0.0</version>
</since>
<synopsis>Raised when a Queue member's status has changed.</synopsis>
<syntax>
<parameter name="Queue">
@@ -1311,7 +1351,9 @@
</managerEvent>
<managerEvent language="en_US" name="QueueMemberAdded">
<managerEventInstance class="EVENT_FLAG_AGENT">
<since><version>12.0.0</version></since>
<since>
<version>12.0.0</version>
</since>
<synopsis>Raised when a member is added to the queue.</synopsis>
<syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter)" />
@@ -1324,7 +1366,9 @@
</managerEvent>
<managerEvent language="en_US" name="QueueMemberRemoved">
<managerEventInstance class="EVENT_FLAG_AGENT">
<since><version>12.0.0</version></since>
<since>
<version>12.0.0</version>
</since>
<synopsis>Raised when a member is removed from the queue.</synopsis>
<syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter)" />
@@ -1337,7 +1381,9 @@
</managerEvent>
<managerEvent language="en_US" name="QueueMemberPause">
<managerEventInstance class="EVENT_FLAG_AGENT">
<since><version>12.2.0</version></since>
<since>
<version>12.2.0</version>
</since>
<synopsis>Raised when a member is paused/unpaused in the queue.</synopsis>
<syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter)" />
@@ -1350,7 +1396,9 @@
</managerEvent>
<managerEvent language="en_US" name="QueueMemberPenalty">
<managerEventInstance class="EVENT_FLAG_AGENT">
<since><version>12.0.0</version></since>
<since>
<version>12.0.0</version>
</since>
<synopsis>Raised when a member's penalty is changed.</synopsis>
<syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter)" />
@@ -1362,7 +1410,9 @@
</managerEvent>
<managerEvent language="en_US" name="QueueMemberRinginuse">
<managerEventInstance class="EVENT_FLAG_AGENT">
<since><version>12.0.0</version></since>
<since>
<version>12.0.0</version>
</since>
<synopsis>Raised when a member's ringinuse setting is changed.</synopsis>
<syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter)" />
@@ -1374,7 +1424,9 @@
</managerEvent>
<managerEvent language="en_US" name="QueueCallerJoin">
<managerEventInstance class="EVENT_FLAG_AGENT">
<since><version>12.0.0</version></since>
<since>
<version>12.0.0</version>
</since>
<synopsis>Raised when a caller joins a Queue.</synopsis>
<syntax>
<channel_snapshot/>
@@ -1394,7 +1446,9 @@
</managerEvent>
<managerEvent language="en_US" name="QueueCallerLeave">
<managerEventInstance class="EVENT_FLAG_AGENT">
<since><version>12.0.0</version></since>
<since>
<version>12.0.0</version>
</since>
<synopsis>Raised when a caller leaves a Queue.</synopsis>
<syntax>
<channel_snapshot/>
@@ -1409,7 +1463,9 @@
</managerEvent>
<managerEvent language="en_US" name="QueueCallerAbandon">
<managerEventInstance class="EVENT_FLAG_AGENT">
<since><version>12.0.0</version></since>
<since>
<version>12.0.0</version>
</since>
<synopsis>Raised when a caller abandons the queue.</synopsis>
<syntax>
<channel_snapshot/>
@@ -1426,7 +1482,9 @@
</managerEvent>
<managerEvent language="en_US" name="AgentCalled">
<managerEventInstance class="EVENT_FLAG_AGENT">
<since><version>12.0.0</version></since>
<since>
<version>12.0.0</version>
</since>
<synopsis>Raised when an queue member is notified of a caller in the queue.</synopsis>
<syntax>
<channel_snapshot/>
@@ -1444,7 +1502,9 @@
</managerEvent>
<managerEvent language="en_US" name="AgentRingNoAnswer">
<managerEventInstance class="EVENT_FLAG_AGENT">
<since><version>12.0.0</version></since>
<since>
<version>12.0.0</version>
</since>
<synopsis>Raised when a queue member is notified of a caller in the queue and fails to answer.</synopsis>
<syntax>
<channel_snapshot/>
@@ -1463,7 +1523,9 @@
</managerEvent>
<managerEvent language="en_US" name="AgentComplete">
<managerEventInstance class="EVENT_FLAG_AGENT">
<since><version>12.0.0</version></since>
<since>
<version>12.0.0</version>
</since>
<synopsis>Raised when a queue member has finished servicing a caller in the queue.</synopsis>
<syntax>
<channel_snapshot/>
@@ -1491,7 +1553,9 @@
</managerEvent>
<managerEvent language="en_US" name="AgentDump">
<managerEventInstance class="EVENT_FLAG_AGENT">
<since><version>12.0.0</version></since>
<since>
<version>12.0.0</version>
</since>
<synopsis>Raised when a queue member hangs up on a caller in the queue.</synopsis>
<syntax>
<channel_snapshot/>
@@ -1508,7 +1572,9 @@
</managerEvent>
<managerEvent language="en_US" name="AgentConnect">
<managerEventInstance class="EVENT_FLAG_AGENT">
<since><version>12.0.0</version></since>
<since>
<version>12.0.0</version>
</since>
<synopsis>Raised when a queue member answers and is bridged to a caller in the queue.</synopsis>
<syntax>
<channel_snapshot/>