]> 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)
committerGeorge Joseph <gjoseph@sangoma.com>
Mon, 1 Apr 2024 20:19:00 +0000 (20:19 +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.

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

index 95ecd71a86bec96af4bd698092f4367cf691aed2..22aedcad0bf2f13d604ebb2db2c0c70c1723b5e1 100644 (file)
                        <ref type="application">StopMixMonitor</ref>
                        <ref type="application">PauseMonitor</ref>
                        <ref type="application">UnpauseMonitor</ref>
-                       <ref type="function">AUDIOHOOK_INHERIT</ref>
                </see-also>
        </application>
        <application name="StopMixMonitor" language="en_US">
index 557c6f160fb4a9a9b1a345ad4e5d8605739e3290..a927cb574ba2bddb9fda382fdd3e50e27dfb1c16 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 ecf5074d9cb27b4a0e09b110fc88242910b3ac22..5d92b4ad2f854c85043c70bb95fa6cb6a83ac666 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 54fe4ff92a88fdc7c972ca938044fef3f9fe93b2..afe9418ef7079096ff7dda2349ef1cedc03f5910 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 be7f5092a52c874c197ddb4923dfddb30402ff9a..8b26ff97ebe15886ac6184e46296784f8819299b 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">
@@ -2273,7 +2273,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 */