app_queue: Extend documentation for various Manager actions and events.

........

Merged revisions 413485 from http://svn.asterisk.org/svn/asterisk/branches/1.8

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

diff --git a/apps/app_queue.c b/apps/app_queue.c
index e3619067d1a9fc9d0b727552496f6e77c4e5f2b5..b8d275fcdb3919faa4fad035000786a4aedb52a5 100644 (file)
--- a/apps/app_queue.c
+++ b/apps/app_queue.c
@@ -722,6 +722,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
                <syntax>
                </syntax>
                <description>
+                       <para>Show queues information.</para>
                </description>
        </manager>
        <manager name="QueueStatus" language="en_US">
@@ -730,10 +731,15 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
                </synopsis>
                <syntax>
                        <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
-                       <parameter name="Queue" />
-                       <parameter name="Member" />
+                       <parameter name="Queue">
+                               <para>Limit the response to the status of the specified queue.</para>
+                       </parameter>
+                       <parameter name="Member">
+                               <para>Limit the response to the status of the specified member.</para>
+                       </parameter>
                </syntax>
                <description>
+                       <para>Check the status of one or more queues.</para>
                </description>
        </manager>
        <manager name="QueueSummary" language="en_US">
@@ -742,9 +748,12 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
                </synopsis>
                <syntax>
                        <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
-                       <parameter name="Queue" />
+                       <parameter name="Queue">
+                               <para>Queue for which the summary is requested.</para>
+                       </parameter>
                </syntax>
                <description>
+                       <para>Request the manager to send a QueueSummary event.</para>
                </description>
        </manager>
        <manager name="QueueAdd" language="en_US">
@@ -753,11 +762,21 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
                </synopsis>
                <syntax>
                        <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
-                       <parameter name="Queue" required="true" />
-                       <parameter name="Interface" required="true" />
-                       <parameter name="Penalty" />
-                       <parameter name="Paused" />
-                       <parameter name="MemberName" />
+                       <parameter name="Queue" required="true">
+                               <para>Queue's name.</para>
+                       </parameter>
+                       <parameter name="Interface" required="true">
+                               <para>The name of the interface (tech/name) to add to the queue.</para>
+                       </parameter>
+                       <parameter name="Penalty">
+                               <para>A penalty (number) to apply to this member. Asterisk will distribute calls to members with higher penalties only after attempting to distribute calls to those with lower penalty.</para>
+                       </parameter>
+                       <parameter name="Paused">
+                               <para>To pause or not the member initially (true/false or 1/0).</para>
+                       </parameter>
+                       <parameter name="MemberName">
+                               <para>Text alias for the interface.</para>
+                       </parameter>
                        <parameter name="StateInterface" />
                </syntax>
                <description>
@@ -769,8 +788,12 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
                </synopsis>
                <syntax>
                        <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
-                       <parameter name="Queue" required="true" />
-                       <parameter name="Interface" required="true" />
+                       <parameter name="Queue" required="true">
+                               <para>The name of the queue to take action on.</para>
+                       </parameter>
+                       <parameter name="Interface" required="true">
+                               <para>The interface (tech/name) to remove from queue.</para>
+                       </parameter>
                </syntax>
                <description>
                </description>
@@ -781,12 +804,21 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
                </synopsis>
                <syntax>
                        <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
-                       <parameter name="Interface" required="true" />
-                       <parameter name="Paused" required="true" />
-                       <parameter name="Queue" />
-                       <parameter name="Reason" />
+                       <parameter name="Interface" required="true">
+                               <para>The name of the interface (tech/name) to pause or unpause.</para>
+                       </parameter>
+                       <parameter name="Paused" required="true">
+                               <para>Pause or unpause the interface. Set to 'true' to pause the member or 'false' to unpause.</para>
+                       </parameter>
+                       <parameter name="Queue">
+                               <para>The name of the queue in which to pause or unpause this member. If not specified, the member will be paused or unpaused in all the queues it is a member of.</para>
+                       </parameter>
+                       <parameter name="Reason">
+                               <para>Text description, returned in the event QueueMemberPaused.</para>
+                       </parameter>
                </syntax>
                <description>
+                       <para>Pause or unpause a member in a queue.</para>
                </description>
        </manager>
        <manager name="QueueLog" language="en_US">
@@ -810,11 +842,18 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
                </synopsis>
                <syntax>
                        <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
-                       <parameter name="Interface" required="true" />
-                       <parameter name="Penalty" required="true" />
-                       <parameter name="Queue" />
+                       <parameter name="Interface" required="true">
+                               <para>The interface (tech/name) of the member whose penalty to change.</para>
+                       </parameter>
+                       <parameter name="Penalty" required="true">
+                               <para>The new penalty (number) for the member. Must be nonnegative.</para>
+                       </parameter>
+                       <parameter name="Queue">
+                               <para>If specified, only set the penalty for the member of this queue. Otherwise, set the penalty for the member in all queues to which the member belongs.</para>
+                       </parameter>
                </syntax>
                <description>
+                       <para>Change the penalty of a queue member</para>
                </description>
        </manager>
 
@@ -838,9 +877,12 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
                </synopsis>
                <syntax>
                        <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
-                       <parameter name="Rule" />
+                       <parameter name="Rule">
+                               <para>The name of the rule in queuerules.conf whose contents to list.</para>
+                       </parameter>
                </syntax>
                <description>
+                       <para>List queue rules defined in queuerules.conf</para>
                </description>
        </manager>
        <manager name="QueueReload" language="en_US">
@@ -849,20 +891,25 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
                </synopsis>
                <syntax>
                        <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
-                       <parameter name="Queue" />
+                       <parameter name="Queue">
+                               <para>The name of the queue to take action on. If no queue name is specified, then all queues are affected.</para>
+                       </parameter>
                        <parameter name="Members">
+                               <para>Whether to reload the queue's members.</para>
                                <enumlist>
                                        <enum name="yes" />
                                        <enum name="no" />
                                </enumlist>
                        </parameter>
                        <parameter name="Rules">
+                               <para>Whether to reload queuerules.conf</para>
                                <enumlist>
                                        <enum name="yes" />
                                        <enum name="no" />
                                </enumlist>
                        </parameter>
                        <parameter name="Parameters">
+                               <para>Whether to reload the other queue options.</para>
                                <enumlist>
                                        <enum name="yes" />
                                        <enum name="no" />
@@ -878,9 +925,12 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
                </synopsis>
                <syntax>
                        <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
-                       <parameter name="Queue" />
+                       <parameter name="Queue">
+                               <para>The name of the queue on which to reset statistics.</para>
+                       </parameter>
                </syntax>
                <description>
+                       <para>Reset the statistics for a queue.</para>
                </description>
        </manager>
  ***/

diff --git a/main/manager.c b/main/manager.c
index 9387800dce79352a8ab28db9de4b54c701956ad0..e26d0743d75572e4fa828128c685581e52b29ce6 100644 (file)
--- a/main/manager.c
+++ b/main/manager.c
@@ -773,6 +773,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
                        Check if module is loaded.
                </synopsis>
                <syntax>
+                       <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
                        <parameter name="Module" required="true">
                                <para>Asterisk module name (not including extension).</para>
                        </parameter>