]> git.ipfire.org Git - thirdparty/asterisk.git/commitdiff
Fix incorrect application and function documentation references
authorGeorge Joseph <gjoseph@sangoma.com>
Mon, 1 Apr 2024 12:30:54 +0000 (06:30 -0600)
committerAsterisk Development Team <asteriskteam@digium.com>
Thu, 9 May 2024 13:48:09 +0000 (13:48 +0000)
There were a few references in the embedded documentation XML
where the case didn't match or where the referenced app or function
simply didn't exist any more.  These were causing 404 responses
in docs.asterisk.org.

(cherry picked from commit 9e2179baa10de329f7626f6a43af2a365194ce85)

apps/app_mixmonitor.c
apps/app_stack.c
channels/chan_iax2.c
main/pbx_builtins.c
res/res_fax.c

index 0056a746beac3729cb89f355ec47efbfe9220c35..869d5537cb993461b5ddfe06cf1a72e33cc5587c 100644 (file)
                </description>
                <see-also>
                        <ref type="application">StopMixMonitor</ref>
-                       <ref type="function">AUDIOHOOK_INHERIT</ref>
                </see-also>
        </application>
        <application name="StopMixMonitor" language="en_US">
index 41fba7911a83cbe668284cf55d5a8b5fcdb76247..06cd3be0519ca3eb3a7b43894266182f0a030d07 100644 (file)
                        returning to the dialplan with execution of a Return().</para>
                </description>
                <see-also>
-                       <ref type="application">GoSub</ref>
+                       <ref type="application">Gosub</ref>
                </see-also>
        </agi>
        <managerEvent language="en_US" name="VarSet">
                                </parameter>
                        </syntax>
                        <see-also>
-                               <ref type="application">GoSub</ref>
+                               <ref type="application">Gosub</ref>
                                <ref type="agi">gosub</ref>
                                <ref type="function">LOCAL</ref>
                                <ref type="function">LOCAL_PEEK</ref>
index cbf4ab4479cbafda792175b0c9c672be9012ae36..c499e1e69e451c4c0ab71870a594e3979c045892 100644 (file)
                <description>
                        <para>Gets information associated with the specified IAX2 peer.</para>
                </description>
-               <see-also>
-                       <ref type="function">SIPPEER</ref>
-               </see-also>
        </function>
        <function name="IAXVAR" language="en_US">
                <synopsis>
index 17869ad12e900d49a5fb5043f8ca7de13f761389..fd778436434c7f7fab82dbba691ac2e19b8dcde9 100644 (file)
                <see-also>
                        <ref type="application">Congestion</ref>
                        <ref type="application">Progress</ref>
-                       <ref type="application">Playtones</ref>
+                       <ref type="application">PlayTones</ref>
                        <ref type="application">Hangup</ref>
                </see-also>
        </application>
                <see-also>
                        <ref type="application">Busy</ref>
                        <ref type="application">Progress</ref>
-                       <ref type="application">Playtones</ref>
+                       <ref type="application">PlayTones</ref>
                        <ref type="application">Hangup</ref>
                </see-also>
        </application>
                        <ref type="application">Busy</ref>
                        <ref type="application">Congestion</ref>
                        <ref type="application">Ringing</ref>
-                       <ref type="application">Playtones</ref>
+                       <ref type="application">PlayTones</ref>
                </see-also>
        </application>
        <application name="RaiseException" language="en_US">
                        dialplan function EXCEPTION(). If the <literal>e</literal> extension does not exist, the call will hangup.</para>
                </description>
                <see-also>
-                       <ref type="function">Exception</ref>
+                       <ref type="function">EXCEPTION</ref>
                </see-also>
        </application>
        <application name="Ringing" language="en_US">
                        <ref type="application">Busy</ref>
                        <ref type="application">Congestion</ref>
                        <ref type="application">Progress</ref>
-                       <ref type="application">Playtones</ref>
+                       <ref type="application">PlayTones</ref>
                </see-also>
        </application>
        <application name="SayAlpha" language="en_US">
index 79abd8b52238f929c2b23274acc687a5b2bc0d91..eab840ed2b2a717a489d2925dfa5225b1307cccd 100644 (file)
                <description>
                        <para>This application is provided by res_fax, which is a FAX technology agnostic module
                        that utilizes FAX technology resource modules to complete a FAX transmission.</para>
-                       <para>Session arguments can be set by the FAXOPT function and to check results of the ReceiveFax() application.</para>
+                       <para>Session arguments can be set by the FAXOPT function and to check results of the ReceiveFAX() application.</para>
                </description>
                <see-also>
                        <ref type="function">FAXOPT</ref>
                <description>
                        <para>This application is provided by res_fax, which is a FAX technology agnostic module
                        that utilizes FAX technology resource modules to complete a FAX transmission.</para>
-                       <para>Session arguments can be set by the FAXOPT function and to check results of the SendFax() application.</para>
+                       <para>Session arguments can be set by the FAXOPT function and to check results of the SendFAX() application.</para>
                </description>
                <see-also>
                        <ref type="function">FAXOPT</ref>
                        it can also be used to retrieve information about a FAX session that has finished eg. pages/status.</para>
                </description>
                <see-also>
-                       <ref type="application">ReceiveFax</ref>
-                       <ref type="application">SendFax</ref>
+                       <ref type="application">ReceiveFAX</ref>
+                       <ref type="application">SendFAX</ref>
                </see-also>
        </function>
        <manager name="FAXSessions" language="en_US">
@@ -2272,7 +2272,7 @@ static int receivefax_exec(struct ast_channel *chan, const char *data)
        }
 
        if (report_receive_fax_status(chan, args.filename)) {
-               ast_log(AST_LOG_ERROR, "Error publishing ReceiveFax status message\n");
+               ast_log(AST_LOG_ERROR, "Error publishing ReceiveFAX status message\n");
        }
 
        /* If the channel hungup return -1; otherwise, return 0 to continue in the dialplan */