From f9c3b262411fa3281537beea8c8007b31296e828 Mon Sep 17 00:00:00 2001
From: Andrew Latham <lathama@gmail.com>
Date: Sun, 30 Jan 2011 00:22:59 +0000
Subject: [PATCH] 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
---
apps/app_externalivr.c | 2 +-
apps/app_queue.c | 164 +++++++++++++++++++++++++++++++++++-
apps/app_voicemail.c | 2 +-
funcs/func_callcompletion.c | 4 +-
funcs/func_realtime.c | 30 +++++++
res/res_calendar.c | 30 +++++++
6 files changed, 225 insertions(+), 7 deletions(-)
diff --git a/apps/app_externalivr.c b/apps/app_externalivr.c
index b0b2254d48..093e9ae272 100644
--- a/apps/app_externalivr.c
+++ b/apps/app_externalivr.c
@@ -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>
***/
diff --git a/apps/app_queue.c b/apps/app_queue.c
index 6557edd507..2c0833360c 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>
diff --git a/apps/app_voicemail.c b/apps/app_voicemail.c
index 6d3de28546..2c5b97b851 100644
--- a/apps/app_voicemail.c
+++ b/apps/app_voicemail.c
@@ -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.
diff --git a/funcs/func_callcompletion.c b/funcs/func_callcompletion.c
index 03bf858415..6a7ced201f 100644
--- a/funcs/func_callcompletion.c
+++ b/funcs/func_callcompletion.c
@@ -57,8 +57,8 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
completion configuration parameter for a channel. Note that setting
a configuration parameter will only change the parameter for the
duration of the call.
-
- For more information on call completion in Asterisk, see <filename>doc/tex/ccss.tex</filename>.
+
+ For more information see <filename>doc/asterisk.pdf</filename>.
For more information on call completion parameters, see <filename>configs/ccss.conf.sample</filename>.</para>
</description>
</function>
diff --git a/funcs/func_realtime.c b/funcs/func_realtime.c
index 9add21217d..d8251f4c6a 100644
--- a/funcs/func_realtime.c
+++ b/funcs/func_realtime.c
@@ -67,6 +67,12 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
If there is no match, NULL will be returned by the function.
On a write, this function will always return NULL.</para>
</description>
+ <see-also>
+ <ref type="function">REALTIME_STORE</ref>
+ <ref type="function">REALTIME_DESTROY</ref>
+ <ref type="function">REALTIME_FIELD</ref>
+ <ref type="function">REALTIME_HASH</ref>
+ </see-also>
</function>
<function name="REALTIME_STORE" language="en_US">
<synopsis>
@@ -84,6 +90,12 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
creates channel variable named RTSTOREID, which contains value of unique ID.
Currently, a maximum of 30 field/value pairs is supported.</para>
</description>
+ <see-also>
+ <ref type="function">REALTIME</ref>
+ <ref type="function">REALTIME_DESTROY</ref>
+ <ref type="function">REALTIME_FIELD</ref>
+ <ref type="function">REALTIME_HASH</ref>
+ </see-also>
</function>
<function name="REALTIME_DESTROY" language="en_US">
<synopsis>
@@ -100,6 +112,12 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
<para>This function acts in the same way as REALTIME(....) does, except that
it destroys the matched record in the RT engine.</para>
</description>
+ <see-also>
+ <ref type="function">REALTIME</ref>
+ <ref type="function">REALTIME_STORE</ref>
+ <ref type="function">REALTIME_FIELD</ref>
+ <ref type="function">REALTIME_HASH</ref>
+ </see-also>
</function>
<function name="REALTIME_FIELD" language="en_US">
<synopsis>
@@ -117,6 +135,12 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
<replaceable>value</replaceable>. When written to, the REALTIME_FIELD() function
performs identically to the REALTIME() function.</para>
</description>
+ <see-also>
+ <ref type="function">REALTIME</ref>
+ <ref type="function">REALTIME_STORE</ref>
+ <ref type="function">REALTIME_DESTROY</ref>
+ <ref type="function">REALTIME_HASH</ref>
+ </see-also>
</function>
<function name="REALTIME_HASH" language="en_US">
<synopsis>
@@ -134,6 +158,12 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
it can be assigned to the HASH() function. The HASH() function then provides
a suitable method for retrieving each field value of the record.</para>
</description>
+ <see-also>
+ <ref type="function">REALTIME</ref>
+ <ref type="function">REALTIME_STORE</ref>
+ <ref type="function">REALTIME_DESTROY</ref>
+ <ref type="function">REALTIME_FIELD</ref>
+ </see-also>
</function>
***/
diff --git a/res/res_calendar.c b/res/res_calendar.c
index f95c17de22..d5c716025b 100644
--- a/res/res_calendar.c
+++ b/res/res_calendar.c
@@ -53,6 +53,12 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
<description>
<para>Check the specified calendar's current busy status.</para>
</description>
+ <see-also>
+ <ref type="function">CALENDAR_EVENT</ref>
+ <ref type="function">CALENDAR_QUERY</ref>
+ <ref type="function">CALENDAR_QUERY_RESULT</ref>
+ <ref type="function">CALENDAR_WRITE</ref>
+ </see-also>
</function>
<function name="CALENDAR_EVENT" language="en_US">
<synopsis>
@@ -79,6 +85,12 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
<para>Whenever a calendar event notification call is made, the event data
may be accessed with this function.</para>
</description>
+ <see-also>
+ <ref type="function">CALENDAR_BUSY</ref>
+ <ref type="function">CALENDAR_QUERY</ref>
+ <ref type="function">CALENDAR_QUERY_RESULT</ref>
+ <ref type="function">CALENDAR_WRITE</ref>
+ </see-also>
</function>
<function name="CALENDAR_QUERY" language="en_US">
<synopsis>Query a calendar server and store the data on a channel
@@ -98,6 +110,12 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
<para>Get a list of events in the currently accessible timeframe of the <replaceable>calendar</replaceable>
The function returns the id for accessing the result with CALENDAR_QUERY_RESULT()</para>
</description>
+ <see-also>
+ <ref type="function">CALENDAR_BUSY</ref>
+ <ref type="function">CALENDAR_EVENT</ref>
+ <ref type="function">CALENDAR_QUERY_RESULT</ref>
+ <ref type="function">CALENDAR_WRITE</ref>
+ </see-also>
</function>
<function name="CALENDAR_QUERY_RESULT" language="en_US">
<synopsis>
@@ -133,6 +151,12 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
will return the data for that field. If multiple events matched the query, and <replaceable>entry</replaceable>
is provided, information from that event will be returned.</para>
</description>
+ <see-also>
+ <ref type="function">CALENDAR_BUSY</ref>
+ <ref type="function">CALENDAR_EVENT</ref>
+ <ref type="function">CALENDAR_QUERY</ref>
+ <ref type="function">CALENDAR_WRITE</ref>
+ </see-also>
</function>
<function name="CALENDAR_WRITE" language="en_US">
<synopsis>Write an event to a calendar</synopsis>
@@ -159,6 +183,12 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
<para>Example: CALENDAR_WRITE(calendar,field1,field2,field3)=val1,val2,val3</para>
<para>The field and value arguments can easily be set/passed using the HASHKEYS() and HASH() functions</para>
</description>
+ <see-also>
+ <ref type="function">CALENDAR_BUSY</ref>
+ <ref type="function">CALENDAR_EVENT</ref>
+ <ref type="function">CALENDAR_QUERY</ref>
+ <ref type="function">CALENDAR_QUERY_RESULT</ref>
+ </see-also>
</function>
***/
--
GitLab