From d23dff9ca85e820cb8b4e0d7d51616af20a17afe Mon Sep 17 00:00:00 2001
From: "Eliel C. Sardanons" <eliels@gmail.com>
Date: Wed, 5 Nov 2008 12:13:57 +0000
Subject: [PATCH] - Add some see-also references based on TFOT.
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@154542 65c4cc65-6c06-0410-ace0-fbb531ad65f3
---
apps/app_db.c | 7 +++++++
apps/app_queue.c | 37 +++++++++++++++++++++++++++++++++++++
apps/app_readfile.c | 4 ++++
apps/app_senddtmf.c | 3 +++
apps/app_sendtext.c | 4 ++++
apps/app_url.c | 4 ++++
funcs/func_blacklist.c | 3 +++
funcs/func_db.c | 14 ++++++++++++++
8 files changed, 76 insertions(+)
diff --git a/apps/app_db.c b/apps/app_db.c
index 72b604680b..3a89b867b7 100644
--- a/apps/app_db.c
+++ b/apps/app_db.c
@@ -55,6 +55,8 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
</description>
<see-also>
<ref type="function">DB_DELETE</ref>
+ <ref type="application">DBdeltree</ref>
+ <ref type="function">DB</ref>
</see-also>
</application>
<application name="DBdeltree" language="en_US">
@@ -69,6 +71,11 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
<para>This application will delete a <replaceable>family</replaceable> or <replaceable>keytree</replaceable>
from the Asterisk database.</para>
</description>
+ <see-also>
+ <ref type="function">DB_DELETE</ref>
+ <ref type="application">DBdel</ref>
+ <ref type="function">DB</ref>
+ </see-also>
</application>
***/
diff --git a/apps/app_queue.c b/apps/app_queue.c
index eef55f55b9..a4b86f5fb6 100644
--- a/apps/app_queue.c
+++ b/apps/app_queue.c
@@ -214,6 +214,16 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
</variable>
</variablelist>
</description>
+ <see-also>
+ <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_MEMBER_COUNT</ref>
+ <ref type="function">QUEUE_MEMBER_LIST</ref>
+ <ref type="function">QUEUE_WAITING_COUNT</ref>
+ </see-also>
</application>
<application name="AddQueueMember" language="en_US">
<synopsis>
@@ -240,6 +250,12 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
</variable>
</variablelist>
</description>
+ <see-also>
+ <ref type="application">RemoveQueueMember</ref>
+ <ref type="application">PauseQueueMember</ref>
+ <ref type="application">UnpauseQueueMember</ref>
+ <ref type="application">AgentLogin</ref>
+ </see-also>
</application>
<application name="RemoveQueueMember" language="en_US">
<synopsis>
@@ -262,6 +278,12 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
</variablelist>
<para>Example: RemoveQueueMember(techsupport,SIP/3000)</para>
</description>
+ <see-also>
+ <ref type="application">Queue</ref>
+ <ref type="application">AddQueueMember</ref>
+ <ref type="application">PauseQueueMember</ref>
+ <ref type="application">UnpauseQueueMember</ref>
+ </see-also>
</application>
<application name="PauseQueueMember" language="en_US">
<synopsis>
@@ -291,6 +313,9 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
</variablelist>
<para>Example: PauseQueueMember(,SIP/3000)</para>
</description>
+ <see-also>
+ <ref type="application">UnpauseQueueMember</ref>
+ </see-also>
</application>
<application name="UnpauseQueueMember" language="en_US">
<synopsis>
@@ -317,6 +342,9 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
</variablelist>
<para>Example: UnpauseQueueMember(,SIP/3000)</para>
</description>
+ <see-also>
+ <ref type="application">PauseQueueMember</ref>
+ </see-also>
</application>
<application name="QueueLog" language="en_US">
<synopsis>
@@ -333,6 +361,9 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
<para>Allows you to write your own events into the queue log.</para>
<para>Example: QueueLog(101,${UNIQUEID},${AGENT},WENTONBREAK,600)</para>
</description>
+ <see-also>
+ <ref type="application">Queue</ref>
+ </see-also>
</application>
<function name="QUEUE_VARIABLES" language="en_US">
<synopsis>
@@ -408,6 +439,9 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
<para>Returns the number of members currently associated with the specified <replaceable>queuename</replaceable>.</para>
<warning><para>This function has been deprecated in favor of the <literal>QUEUE_MEMBER()</literal> function</para></warning>
</description>
+ <see-also>
+ <ref type="function">QUEUE_MEMBER_LIST</ref>
+ </see-also>
</function>
<function name="QUEUE_WAITING_COUNT" language="en_US">
<synopsis>
@@ -430,6 +464,9 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
<description>
<para>Returns a comma-separated list of members associated with the specified <replaceable>queuename</replaceable>.</para>
</description>
+ <see-also>
+ <ref type="function">QUEUE_MEMBER_COUNT</ref>
+ </see-also>
</function>
<function name="QUEUE_MEMBER_PENALTY" language="en_US">
<synopsis>
diff --git a/apps/app_readfile.c b/apps/app_readfile.c
index c5234089f0..b65dbf6567 100644
--- a/apps/app_readfile.c
+++ b/apps/app_readfile.c
@@ -58,6 +58,10 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
<para>Read the contents of a text file into channel variable <replaceable>varname</replaceable></para>
<warning><para>ReadFile has been deprecated in favor of Set(varname=${FILE(file,0,length)})</para></warning>
</description>
+ <see-also>
+ <ref type="application">System</ref>
+ <ref type="application">Read</ref>
+ </see-also>
</application>
***/
diff --git a/apps/app_senddtmf.c b/apps/app_senddtmf.c
index bd92230bd6..05faf2221a 100644
--- a/apps/app_senddtmf.c
+++ b/apps/app_senddtmf.c
@@ -55,6 +55,9 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
<para>DTMF digits sent to a channel with half second pause</para>
<para>It will pass all digits or terminate if it encounters an error.</para>
</description>
+ <see-also>
+ <ref type="application">Read</ref>
+ </see-also>
</application>
***/
static char *app = "SendDTMF";
diff --git a/apps/app_sendtext.c b/apps/app_sendtext.c
index 53306aa5ab..91273b45ac 100644
--- a/apps/app_sendtext.c
+++ b/apps/app_sendtext.c
@@ -63,6 +63,10 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
</variablelist>
<note><para>At this moment, text is supposed to be 7 bit ASCII in most channels.</para></note>
</description>
+ <see-also>
+ <ref type="application">SendImage</ref>
+ <ref type="application">SendURL</ref>
+ </see-also>
</application>
***/
diff --git a/apps/app_url.c b/apps/app_url.c
index e20159f5a1..af72b44efc 100644
--- a/apps/app_url.c
+++ b/apps/app_url.c
@@ -73,6 +73,10 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
<para>SendURL continues normally if the URL was sent correctly or if the channel
does not support HTML transport. Otherwise, the channel is hung up.</para>
</description>
+ <see-also>
+ <ref type="application">SendImage</ref>
+ <ref type="application">SendText</ref>
+ </see-also>
</application>
***/
diff --git a/funcs/func_blacklist.c b/funcs/func_blacklist.c
index c353b20fd7..304ba9bdfd 100644
--- a/funcs/func_blacklist.c
+++ b/funcs/func_blacklist.c
@@ -45,6 +45,9 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
<para>Uses astdb to check if the Caller*ID is in family <literal>blacklist</literal>.
Returns <literal>1</literal> or <literal>0</literal>.</para>
</description>
+ <see-also>
+ <ref type="function">DB</ref>
+ </see-also>
</function>
***/
diff --git a/funcs/func_db.c b/funcs/func_db.c
index 9c8e0bdf90..5fa753f6da 100644
--- a/funcs/func_db.c
+++ b/funcs/func_db.c
@@ -56,6 +56,12 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
DB_RESULT. If you wish to find out if an entry exists, use the DB_EXISTS
function.</para>
</description>
+ <see-also>
+ <ref type="application">DBdel</ref>
+ <ref type="function">DB_DELETE</ref>
+ <ref type="application">DBdeltree</ref>
+ <ref type="function">DB_EXISTS</ref>
+ </see-also>
</function>
<function name="DB_EXISTS" language="en_US">
<synopsis>
@@ -71,6 +77,9 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
it will return <literal>0</literal>. Checking for existence of a database key will
also set the variable DB_RESULT to the key's value if it exists.</para>
</description>
+ <see-also>
+ <ref type="function">DB</ref>
+ </see-also>
</function>
<function name="DB_DELETE" language="en_US">
<synopsis>
@@ -85,6 +94,11 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
and then remove that key from the database. <variable>DB_RESULT</variable>
will be set to the key's value if it exists.</para>
</description>
+ <see-also>
+ <ref type="application">DBdel</ref>
+ <ref type="function">DB</ref>
+ <ref type="application">DBdeltree</ref>
+ </see-also>
</function>
***/
--
GitLab