kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-10-27 06:31:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add Function and Application Relationships to documentation

Browse Source 
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/branches/1.8@304908 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
Andrew Latham
2011-01-30 00:11:56 +00:00
parent 29a1b6f336
commit b7d7fc94c2
6 changed files with 225 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
apps/app_externalivr.c
View File

@@ -85,7 +85,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
all DTMF events received on the channel, and notification if the channel is
hung up. The received on the channel, and notification if the channel is hung
up. The application will not be forcibly terminated when the channel is hung up.
See <filename>doc/externalivr.txt</filename> for a protocol specification.</para>
For more information see <filename>doc/asterisk.pdf</filename>.</para>
</description>
</application>
***/

164
apps/app_queue.c
View File

@@ -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>

2
apps/app_voicemail.c
View File

@@ -27,7 +27,7 @@
*
* \par See also
* \arg \ref Config_vm
* \note For information about voicemail IMAP storage, read doc/imapstorage.txt
* \note For information about voicemail IMAP storage, read doc/asterisk.pdf
* \ingroup applications
* \note This module requires res_adsi to load. This needs to be optional
* during compilation.