]> git.ipfire.org Git - thirdparty/asterisk.git/commitdiff
app_queue: Fix documentation generation
authorKinsey Moore <kmoore@digium.com>
Fri, 28 Feb 2014 21:13:49 +0000 (21:13 +0000)
committerKinsey Moore <kmoore@digium.com>
Fri, 28 Feb 2014 21:13:49 +0000 (21:13 +0000)
The documentation for QueueMemberPaused was causing documentation
generation to fail because the documentation for that AMI event was in
the wrong location. This moves that documentation the correct location
and adds a missing parameter.

(closes issue SWDAT-261)

git-svn-id: https://origsvn.digium.com/svn/asterisk/branches/11@409208 65c4cc65-6c06-0410-ace0-fbb531ad65f3

apps/app_queue.c

index aae27495bb3f233e5a94eb33f087e9c4454d7398..53380cc6e6505b419d0f1680048957462c0bbd5a 100644 (file)
@@ -6276,22 +6276,25 @@ static int set_member_paused(const char *queuename, const char *interface, const
 
                                ast_queue_log(q->name, "NONE", mem->membername, (paused ? "PAUSE" : "UNPAUSE"), "%s", S_OR(reason, ""));
 
-                               /*** DOCUMENTATION
-                               <managerEventInstance>
-                                       <synopsis>Raised when a member is paused/unpaused in the queue with a reason.</synopsis>
-                                       <syntax>
-                                               <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Queue'])" />
-                                               <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Location'])" />
-                                               <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='MemberName'])" />
-                                               <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Paused'])" />
-                                       </syntax>
-                                       <see-also>
-                                               <ref type="application">PauseQueueMember</ref>
-                                               <ref type="application">UnPauseQueueMember</ref>
-                                       </see-also>
-                               </managerEventInstance>
-                               ***/
                                if (!ast_strlen_zero(reason)) {
+                                       /*** DOCUMENTATION
+                                       <managerEventInstance>
+                                               <synopsis>Raised when a member is paused/unpaused in the queue with a reason.</synopsis>
+                                               <syntax>
+                                                       <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Queue'])" />
+                                                       <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Location'])" />
+                                                       <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='MemberName'])" />
+                                                       <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter[@name='Paused'])" />
+                                                       <parameter name="Reason">
+                                                               <para>The reason given for pausing or unpausing a queue member.</para>
+                                                       </parameter>
+                                               </syntax>
+                                               <see-also>
+                                                       <ref type="application">PauseQueueMember</ref>
+                                                       <ref type="application">UnPauseQueueMember</ref>
+                                               </see-also>
+                                       </managerEventInstance>
+                                       ***/
                                        manager_event(EVENT_FLAG_AGENT, "QueueMemberPaused",
                                                "Queue: %s\r\n"
                                                "Location: %s\r\n"