diff options
| author | Andrew Latham <lathama@gmail.com> | 2011-01-30 00:22:59 +0000 |
|---|---|---|
| committer | Andrew Latham <lathama@gmail.com> | 2011-01-30 00:22:59 +0000 |
| commit | f9c3b262411fa3281537beea8c8007b31296e828 (patch) | |
| tree | b220c82f4aa90c77826c7b43a44453cef303bfbe /apps/app_queue.c | |
| parent | 078f73d6972bca4eb487c67675926ef25255d1db (diff) | |
Add Function and Application Relationships to documentation
Add and extend the see-also sections to the documentation for applications
and functions in an effort to expand the online documentation of the wiki.
Also check for and update any links to moved documentation in the doc folder.
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@304913 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'apps/app_queue.c')
| -rw-r--r-- | apps/app_queue.c | 164 |
1 files changed, 161 insertions, 3 deletions
diff --git a/apps/app_queue.c b/apps/app_queue.c index 6557edd50..2c0833360 100644 --- a/apps/app_queue.c +++ b/apps/app_queue.c @@ -238,14 +238,19 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") </variablelist> </description> <see-also> + <ref type="application">Queue</ref> + <ref type="application">QueueLog</ref> <ref type="application">AddQueueMember</ref> <ref type="application">RemoveQueueMember</ref> <ref type="application">PauseQueueMember</ref> <ref type="application">UnpauseQueueMember</ref> - <ref type="application">AgentLogin</ref> + <ref type="function">QUEUE_VARIABLES</ref> + <ref type="function">QUEUE_MEMBER</ref> <ref type="function">QUEUE_MEMBER_COUNT</ref> - <ref type="function">QUEUE_MEMBER_LIST</ref> + <ref type="function">QUEUE_EXISTS</ref> <ref type="function">QUEUE_WAITING_COUNT</ref> + <ref type="function">QUEUE_MEMBER_LIST</ref> + <ref type="function">QUEUE_MEMBER_PENALTY</ref> </see-also> </application> <application name="AddQueueMember" language="en_US"> @@ -274,10 +279,19 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") </variablelist> </description> <see-also> + <ref type="application">Queue</ref> + <ref type="application">QueueLog</ref> + <ref type="application">AddQueueMember</ref> <ref type="application">RemoveQueueMember</ref> <ref type="application">PauseQueueMember</ref> <ref type="application">UnpauseQueueMember</ref> - <ref type="application">AgentLogin</ref> + <ref type="function">QUEUE_VARIABLES</ref> + <ref type="function">QUEUE_MEMBER</ref> + <ref type="function">QUEUE_MEMBER_COUNT</ref> + <ref type="function">QUEUE_EXISTS</ref> + <ref type="function">QUEUE_WAITING_COUNT</ref> + <ref type="function">QUEUE_MEMBER_LIST</ref> + <ref type="function">QUEUE_MEMBER_PENALTY</ref> </see-also> </application> <application name="RemoveQueueMember" language="en_US"> @@ -303,9 +317,18 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") </description> <see-also> <ref type="application">Queue</ref> + <ref type="application">QueueLog</ref> <ref type="application">AddQueueMember</ref> + <ref type="application">RemoveQueueMember</ref> <ref type="application">PauseQueueMember</ref> <ref type="application">UnpauseQueueMember</ref> + <ref type="function">QUEUE_VARIABLES</ref> + <ref type="function">QUEUE_MEMBER</ref> + <ref type="function">QUEUE_MEMBER_COUNT</ref> + <ref type="function">QUEUE_EXISTS</ref> + <ref type="function">QUEUE_WAITING_COUNT</ref> + <ref type="function">QUEUE_MEMBER_LIST</ref> + <ref type="function">QUEUE_MEMBER_PENALTY</ref> </see-also> </application> <application name="PauseQueueMember" language="en_US"> @@ -337,7 +360,19 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") <para>Example: PauseQueueMember(,SIP/3000)</para> </description> <see-also> + <ref type="application">Queue</ref> + <ref type="application">QueueLog</ref> + <ref type="application">AddQueueMember</ref> + <ref type="application">RemoveQueueMember</ref> + <ref type="application">PauseQueueMember</ref> <ref type="application">UnpauseQueueMember</ref> + <ref type="function">QUEUE_VARIABLES</ref> + <ref type="function">QUEUE_MEMBER</ref> + <ref type="function">QUEUE_MEMBER_COUNT</ref> + <ref type="function">QUEUE_EXISTS</ref> + <ref type="function">QUEUE_WAITING_COUNT</ref> + <ref type="function">QUEUE_MEMBER_LIST</ref> + <ref type="function">QUEUE_MEMBER_PENALTY</ref> </see-also> </application> <application name="UnpauseQueueMember" language="en_US"> @@ -366,7 +401,19 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") <para>Example: UnpauseQueueMember(,SIP/3000)</para> </description> <see-also> + <ref type="application">Queue</ref> + <ref type="application">QueueLog</ref> + <ref type="application">AddQueueMember</ref> + <ref type="application">RemoveQueueMember</ref> <ref type="application">PauseQueueMember</ref> + <ref type="application">UnpauseQueueMember</ref> + <ref type="function">QUEUE_VARIABLES</ref> + <ref type="function">QUEUE_MEMBER</ref> + <ref type="function">QUEUE_MEMBER_COUNT</ref> + <ref type="function">QUEUE_EXISTS</ref> + <ref type="function">QUEUE_WAITING_COUNT</ref> + <ref type="function">QUEUE_MEMBER_LIST</ref> + <ref type="function">QUEUE_MEMBER_PENALTY</ref> </see-also> </application> <application name="QueueLog" language="en_US"> @@ -386,6 +433,18 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") </description> <see-also> <ref type="application">Queue</ref> + <ref type="application">QueueLog</ref> + <ref type="application">AddQueueMember</ref> + <ref type="application">RemoveQueueMember</ref> + <ref type="application">PauseQueueMember</ref> + <ref type="application">UnpauseQueueMember</ref> + <ref type="function">QUEUE_VARIABLES</ref> + <ref type="function">QUEUE_MEMBER</ref> + <ref type="function">QUEUE_MEMBER_COUNT</ref> + <ref type="function">QUEUE_EXISTS</ref> + <ref type="function">QUEUE_WAITING_COUNT</ref> + <ref type="function">QUEUE_MEMBER_LIST</ref> + <ref type="function">QUEUE_MEMBER_PENALTY</ref> </see-also> </application> <function name="QUEUE_VARIABLES" language="en_US"> @@ -426,6 +485,21 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") <para>Makes the following queue variables available.</para> <para>Returns <literal>0</literal> if queue is found and setqueuevar is defined, <literal>-1</literal> otherwise.</para> </description> + <see-also> + <ref type="application">Queue</ref> + <ref type="application">QueueLog</ref> + <ref type="application">AddQueueMember</ref> + <ref type="application">RemoveQueueMember</ref> + <ref type="application">PauseQueueMember</ref> + <ref type="application">UnpauseQueueMember</ref> + <ref type="function">QUEUE_VARIABLES</ref> + <ref type="function">QUEUE_MEMBER</ref> + <ref type="function">QUEUE_MEMBER_COUNT</ref> + <ref type="function">QUEUE_EXISTS</ref> + <ref type="function">QUEUE_WAITING_COUNT</ref> + <ref type="function">QUEUE_MEMBER_LIST</ref> + <ref type="function">QUEUE_MEMBER_PENALTY</ref> + </see-also> </function> <function name="QUEUE_MEMBER" language="en_US"> <synopsis> @@ -453,6 +527,21 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") <description> <para>Returns the number of members currently associated with the specified <replaceable>queuename</replaceable>.</para> </description> + <see-also> + <ref type="application">Queue</ref> + <ref type="application">QueueLog</ref> + <ref type="application">AddQueueMember</ref> + <ref type="application">RemoveQueueMember</ref> + <ref type="application">PauseQueueMember</ref> + <ref type="application">UnpauseQueueMember</ref> + <ref type="function">QUEUE_VARIABLES</ref> + <ref type="function">QUEUE_MEMBER</ref> + <ref type="function">QUEUE_MEMBER_COUNT</ref> + <ref type="function">QUEUE_EXISTS</ref> + <ref type="function">QUEUE_WAITING_COUNT</ref> + <ref type="function">QUEUE_MEMBER_LIST</ref> + <ref type="function">QUEUE_MEMBER_PENALTY</ref> + </see-also> </function> <function name="QUEUE_MEMBER_COUNT" language="en_US"> <synopsis> @@ -466,7 +555,19 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") <warning><para>This function has been deprecated in favor of the <literal>QUEUE_MEMBER()</literal> function</para></warning> </description> <see-also> + <ref type="application">Queue</ref> + <ref type="application">QueueLog</ref> + <ref type="application">AddQueueMember</ref> + <ref type="application">RemoveQueueMember</ref> + <ref type="application">PauseQueueMember</ref> + <ref type="application">UnpauseQueueMember</ref> + <ref type="function">QUEUE_VARIABLES</ref> + <ref type="function">QUEUE_MEMBER</ref> + <ref type="function">QUEUE_MEMBER_COUNT</ref> + <ref type="function">QUEUE_EXISTS</ref> + <ref type="function">QUEUE_WAITING_COUNT</ref> <ref type="function">QUEUE_MEMBER_LIST</ref> + <ref type="function">QUEUE_MEMBER_PENALTY</ref> </see-also> </function> <function name="QUEUE_EXISTS" language="en_US"> @@ -479,6 +580,21 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") <description> <para>Returns 1 if the specified queue exists, 0 if it does not</para> </description> + <see-also> + <ref type="application">Queue</ref> + <ref type="application">QueueLog</ref> + <ref type="application">AddQueueMember</ref> + <ref type="application">RemoveQueueMember</ref> + <ref type="application">PauseQueueMember</ref> + <ref type="application">UnpauseQueueMember</ref> + <ref type="function">QUEUE_VARIABLES</ref> + <ref type="function">QUEUE_MEMBER</ref> + <ref type="function">QUEUE_MEMBER_COUNT</ref> + <ref type="function">QUEUE_EXISTS</ref> + <ref type="function">QUEUE_WAITING_COUNT</ref> + <ref type="function">QUEUE_MEMBER_LIST</ref> + <ref type="function">QUEUE_MEMBER_PENALTY</ref> + </see-also> </function> <function name="QUEUE_WAITING_COUNT" language="en_US"> <synopsis> @@ -490,6 +606,21 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") <description> <para>Returns the number of callers currently waiting in the specified <replaceable>queuename</replaceable>.</para> </description> + <see-also> + <ref type="application">Queue</ref> + <ref type="application">QueueLog</ref> + <ref type="application">AddQueueMember</ref> + <ref type="application">RemoveQueueMember</ref> + <ref type="application">PauseQueueMember</ref> + <ref type="application">UnpauseQueueMember</ref> + <ref type="function">QUEUE_VARIABLES</ref> + <ref type="function">QUEUE_MEMBER</ref> + <ref type="function">QUEUE_MEMBER_COUNT</ref> + <ref type="function">QUEUE_EXISTS</ref> + <ref type="function">QUEUE_WAITING_COUNT</ref> + <ref type="function">QUEUE_MEMBER_LIST</ref> + <ref type="function">QUEUE_MEMBER_PENALTY</ref> + </see-also> </function> <function name="QUEUE_MEMBER_LIST" language="en_US"> <synopsis> @@ -502,7 +633,19 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") <para>Returns a comma-separated list of members associated with the specified <replaceable>queuename</replaceable>.</para> </description> <see-also> + <ref type="application">Queue</ref> + <ref type="application">QueueLog</ref> + <ref type="application">AddQueueMember</ref> + <ref type="application">RemoveQueueMember</ref> + <ref type="application">PauseQueueMember</ref> + <ref type="application">UnpauseQueueMember</ref> + <ref type="function">QUEUE_VARIABLES</ref> + <ref type="function">QUEUE_MEMBER</ref> <ref type="function">QUEUE_MEMBER_COUNT</ref> + <ref type="function">QUEUE_EXISTS</ref> + <ref type="function">QUEUE_WAITING_COUNT</ref> + <ref type="function">QUEUE_MEMBER_LIST</ref> + <ref type="function">QUEUE_MEMBER_PENALTY</ref> </see-also> </function> <function name="QUEUE_MEMBER_PENALTY" language="en_US"> @@ -516,6 +659,21 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") <description> <para>Gets or sets queue members penalty.</para> </description> + <see-also> + <ref type="application">Queue</ref> + <ref type="application">QueueLog</ref> + <ref type="application">AddQueueMember</ref> + <ref type="application">RemoveQueueMember</ref> + <ref type="application">PauseQueueMember</ref> + <ref type="application">UnpauseQueueMember</ref> + <ref type="function">QUEUE_VARIABLES</ref> + <ref type="function">QUEUE_MEMBER</ref> + <ref type="function">QUEUE_MEMBER_COUNT</ref> + <ref type="function">QUEUE_EXISTS</ref> + <ref type="function">QUEUE_WAITING_COUNT</ref> + <ref type="function">QUEUE_MEMBER_LIST</ref> + <ref type="function">QUEUE_MEMBER_PENALTY</ref> + </see-also> </function> <manager name="Queues" language="en_US"> <synopsis> |