- Add more <see-also> based on TFOT.
authorEliel C. Sardanons <eliels@gmail.com>
Wed, 5 Nov 2008 13:07:29 +0000 (13:07 +0000)
committerEliel C. Sardanons <eliels@gmail.com>
Wed, 5 Nov 2008 13:07:29 +0000 (13:07 +0000)
- Add the 'filename' type to the see-also ref. To be able to reference a filename.

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

apps/app_adsiprog.c
apps/app_authenticate.c
apps/app_chanspy.c
apps/app_disa.c
apps/app_dumpchan.c
apps/app_image.c
apps/app_page.c
apps/app_stack.c
main/pbx.c

index 126068c..8f789c6 100644 (file)
@@ -60,6 +60,10 @@ static char *app = "ADSIProg";
                <description>
                        <para>This application programs an ADSI Phone with the given script</para>
                </description>
                <description>
                        <para>This application programs an ADSI Phone with the given script</para>
                </description>
+               <see-also>
+                       <ref type="application">GetCPEID</ref>
+                       <ref type="filename">adsi.conf</ref>
+               </see-also>
        </application>
  ***/
 
        </application>
  ***/
 
index 69abf6f..88b2018 100644 (file)
@@ -98,6 +98,10 @@ static char *app = "Authenticate";
                        <para>When using a database key, the value associated with the key can be anything.</para>
                        <para>Users have three attempts to authenticate before the channel is hung up.</para>
                </description>
                        <para>When using a database key, the value associated with the key can be anything.</para>
                        <para>Users have three attempts to authenticate before the channel is hung up.</para>
                </description>
+               <see-also>
+                       <ref type="application">VMAuthenticate</ref>
+                       <ref type="application">DISA</ref>
+               </see-also>
        </application>
  ***/
 
        </application>
  ***/
 
index f4a5a5d..0f9ae44 100644 (file)
@@ -164,6 +164,9 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
                        single digit extension exists in the correct context ChanSpy will exit to it.
                        This also disables choosing a channel based on <literal>chanprefix</literal> and a digit sequence.</para></note>
                </description>
                        single digit extension exists in the correct context ChanSpy will exit to it.
                        This also disables choosing a channel based on <literal>chanprefix</literal> and a digit sequence.</para></note>
                </description>
+               <see-also>
+                       <ref type="application">ExtenSpy</ref>
+               </see-also>
        </application>
        <application name="ExtenSpy" language="en_US">
                <synopsis>
        </application>
        <application name="ExtenSpy" language="en_US">
                <synopsis>
@@ -279,6 +282,9 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
                        single digit extension exists in the correct context ChanSpy will exit to it.
                        This also disables choosing a channel based on <literal>chanprefix</literal> and a digit sequence.</para></note>
                </description>
                        single digit extension exists in the correct context ChanSpy will exit to it.
                        This also disables choosing a channel based on <literal>chanprefix</literal> and a digit sequence.</para></note>
                </description>
+               <see-also>
+                       <ref type="application">ChanSpy</ref>
+               </see-also>
        </application>
 
  ***/
        </application>
 
  ***/
index 515bdce..80aeb09 100644 (file)
@@ -104,6 +104,10 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
                        line, with the sole exception of the options. The file may contain blank
                        lines, or comments starting with <literal>#</literal> or <literal>;</literal>.</para>
                </description>
                        line, with the sole exception of the options. The file may contain blank
                        lines, or comments starting with <literal>#</literal> or <literal>;</literal>.</para>
                </description>
+               <see-also>
+                       <ref type="application">Authenticate</ref>
+                       <ref type="application">VMAuthenticate</ref>
+               </see-also>
        </application>
  ***/
 static char *app = "DISA";
        </application>
  ***/
 static char *app = "DISA";
index e2300db..d3bf17f 100644 (file)
@@ -52,6 +52,10 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
                        displayed when the verbose level is currently set to that number
                        or greater.</para>
                </description>
                        displayed when the verbose level is currently set to that number
                        or greater.</para>
                </description>
+               <see-also>
+                       <ref type="application">NoOp</ref>
+                       <ref type="application">Verbose</ref>
+               </see-also>
        </application>
  ***/
 
        </application>
  ***/
 
index e74397c..a6fbac5 100644 (file)
@@ -62,6 +62,10 @@ static char *app = "SendImage";
                                </variable>
                        </variablelist>
                </description>
                                </variable>
                        </variablelist>
                </description>
+               <see-also>
+                       <ref type="application">SendText</ref>
+                       <ref type="application">SendURL</ref>
+               </see-also>
        </application>
  ***/
 
        </application>
  ***/
 
index ddebbf0..7d1dca4 100644 (file)
@@ -91,6 +91,9 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
                        caller is dumped into the conference as a speaker and the room is
                        destroyed when the original callers leaves.</para>
                </description>
                        caller is dumped into the conference as a speaker and the room is
                        destroyed when the original callers leaves.</para>
                </description>
+               <see-also>
+                       <ref type="application">MeetMe</ref>
+               </see-also>
        </application>
  ***/
 static const char *app_page= "Page";
        </application>
  ***/
 static const char *app_page= "Page";
index beeea30..45db41d 100644 (file)
@@ -59,6 +59,13 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
                <description>
                        <para>Jumps to the label specified, saving the return address.</para>
                </description>
                <description>
                        <para>Jumps to the label specified, saving the return address.</para>
                </description>
+               <see-also>
+                       <ref type="application">GosubIf</ref>
+                       <ref type="application">Macro</ref>
+                       <ref type="application">Goto</ref>
+                       <ref type="application">Return</ref>
+                       <ref type="application">StackPop</ref>
+               </see-also>
        </application>
        <application name="GosubIf" language="en_US">
                <synopsis>
        </application>
        <application name="GosubIf" language="en_US">
                <synopsis>
@@ -82,6 +89,13 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
                        labeliffalse, if specified.  In either case, a jump saves the return point
                        in the dialplan, to be returned to with a Return.</para>
                </description>
                        labeliffalse, if specified.  In either case, a jump saves the return point
                        in the dialplan, to be returned to with a Return.</para>
                </description>
+               <see-also>
+                       <ref type="application">Gosub</ref>
+                       <ref type="application">Return</ref>
+                       <ref type="application">MacroIf</ref>
+                       <ref type="function">IF</ref>
+                       <ref type="application">GotoIf</ref>
+               </see-also>
        </application>
        <application name="Return" language="en_US">
                <synopsis>
        </application>
        <application name="Return" language="en_US">
                <synopsis>
@@ -96,6 +110,10 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
                        <para>Jumps to the last label on the stack, removing it. The return <replaceable>value</replaceable>, if
                        any, is saved in the channel variable <variable>GOSUB_RETVAL</variable>.</para>
                </description>
                        <para>Jumps to the last label on the stack, removing it. The return <replaceable>value</replaceable>, if
                        any, is saved in the channel variable <variable>GOSUB_RETVAL</variable>.</para>
                </description>
+               <see-also>
+                       <ref type="application">Gosub</ref>
+                       <ref type="application">StackPop</ref>
+               </see-also>
        </application>
        <application name="StackPop" language="en_US">
                <synopsis>
        </application>
        <application name="StackPop" language="en_US">
                <synopsis>
@@ -105,6 +123,10 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
                <description>
                        <para>Removes last label on the stack, discarding it.</para>
                </description>
                <description>
                        <para>Removes last label on the stack, discarding it.</para>
                </description>
+               <see-also>
+                       <ref type="application">Return</ref>
+                       <ref type="application">Gosub</ref>
+               </see-also>
        </application>
        <function name="LOCAL" language="en_US">
                <synopsis>
        </application>
        <function name="LOCAL" language="en_US">
                <synopsis>
index 438403e..8ae0879 100644 (file)
@@ -4223,6 +4223,8 @@ static char *xmldoc_build_seealso(const char *type, const char *name)
                        ast_str_append(&outputstr, 0, "%s\n", content);
                } else if (!strcasecmp(typename, "manpage")) {
                        ast_str_append(&outputstr, 0, "ManPage: %s\n", content);
                        ast_str_append(&outputstr, 0, "%s\n", content);
                } else if (!strcasecmp(typename, "manpage")) {
                        ast_str_append(&outputstr, 0, "ManPage: %s\n", content);
+               } else if (!strcasecmp(typename, "filename")) {
+                       ast_str_append(&outputstr, 0, "File: %s\n", content);
                }
                ast_xml_free_text(content);
        }
                }
                ast_xml_free_text(content);
        }