]> 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>
Wed, 3 Apr 2024 12:53:16 +0000 (06:53 -0600)
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 6bd34dd7ab25c3e4c3fc888d4ac106b68ca27cd9..3979f81dc031f8bcf6c427eb64a75381550b014b 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 a84a45c1b4b4a1839f217bd38631de0ac65a953c..4d1ba8de71225fa8ac920db98fc443b5c9697f3a 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 c4baade01c84cd67f485ae878ebfa3b23a09f0d9..5a9cf360c87d9088ee563f8a5aaf1865df6ee180 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 7ef4d031a98659f89d0988b9ee700137936abe20..0fd59b7fbc538a60b14f5b42fbd8938b4d6bd7b0 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 */