comparison libinterp/corefcn/error.cc @ 30588:ed17822e7662

doc: Always have a return value for functions which set internal variables (bug #61681) * call-stack.cc, dirfns.cc, environment.cc, error.cc, help.cc, input.cc, load-save.cc, ls-oct-text.cc, oct-hist.cc, pager.cc, pr-flt-fmt.cc, pr-output.cc, sighandlers.cc, svd.cc, variables.cc, ov-base.cc, ov-java.cc, ov-struct.cc, ov-usr-fcn.cc, ov.cc, pt-eval.cc, disable_diagonal_matrix.m, disable_permutation_matrix.m, disable_range.m: Always have a return value for functions which set internal variables.
author Rik <rik@octave.org>
date Sat, 01 Jan 2022 19:43:52 -0800
parents 83f9f8bda883
children f3e5f531e6b2
comparison
equal deleted inserted replaced
30587:5d379d2ad903 30588:ed17822e7662
2121 2121
2122 DEFMETHOD (beep_on_error, interp, args, nargout, 2122 DEFMETHOD (beep_on_error, interp, args, nargout,
2123 doc: /* -*- texinfo -*- 2123 doc: /* -*- texinfo -*-
2124 @deftypefn {} {@var{val} =} beep_on_error () 2124 @deftypefn {} {@var{val} =} beep_on_error ()
2125 @deftypefnx {} {@var{old_val} =} beep_on_error (@var{new_val}) 2125 @deftypefnx {} {@var{old_val} =} beep_on_error (@var{new_val})
2126 @deftypefnx {} {} beep_on_error (@var{new_val}, "local") 2126 @deftypefnx {} {@var{old_val} =} beep_on_error (@var{new_val}, "local")
2127 Query or set the internal variable that controls whether Octave will try 2127 Query or set the internal variable that controls whether Octave will try
2128 to ring the terminal bell before printing an error message. 2128 to ring the terminal bell before printing an error message.
2129 2129
2130 When called from inside a function with the @qcode{"local"} option, the 2130 When called from inside a function with the @qcode{"local"} option, the
2131 variable is changed locally for the function and any subroutines it calls. 2131 variable is changed locally for the function and any subroutines it calls.
2139 2139
2140 DEFMETHOD (debug_on_error, interp, args, nargout, 2140 DEFMETHOD (debug_on_error, interp, args, nargout,
2141 doc: /* -*- texinfo -*- 2141 doc: /* -*- texinfo -*-
2142 @deftypefn {} {@var{val} =} debug_on_error () 2142 @deftypefn {} {@var{val} =} debug_on_error ()
2143 @deftypefnx {} {@var{old_val} =} debug_on_error (@var{new_val}) 2143 @deftypefnx {} {@var{old_val} =} debug_on_error (@var{new_val})
2144 @deftypefnx {} {} debug_on_error (@var{new_val}, "local") 2144 @deftypefnx {} {@var{old_val} =} debug_on_error (@var{new_val}, "local")
2145 Query or set the internal variable that controls whether Octave will try 2145 Query or set the internal variable that controls whether Octave will try
2146 to enter the debugger when an error is encountered. 2146 to enter the debugger when an error is encountered.
2147 2147
2148 This will also inhibit printing of the normal traceback message (you will 2148 This will also inhibit printing of the normal traceback message (you will
2149 only see the top-level error message). 2149 only see the top-level error message).
2161 2161
2162 DEFMETHOD (debug_on_warning, interp, args, nargout, 2162 DEFMETHOD (debug_on_warning, interp, args, nargout,
2163 doc: /* -*- texinfo -*- 2163 doc: /* -*- texinfo -*-
2164 @deftypefn {} {@var{val} =} debug_on_warning () 2164 @deftypefn {} {@var{val} =} debug_on_warning ()
2165 @deftypefnx {} {@var{old_val} =} debug_on_warning (@var{new_val}) 2165 @deftypefnx {} {@var{old_val} =} debug_on_warning (@var{new_val})
2166 @deftypefnx {} {} debug_on_warning (@var{new_val}, "local") 2166 @deftypefnx {} {@var{old_val} =} debug_on_warning (@var{new_val}, "local")
2167 Query or set the internal variable that controls whether Octave will try 2167 Query or set the internal variable that controls whether Octave will try
2168 to enter the debugger when a warning is encountered. 2168 to enter the debugger when a warning is encountered.
2169 2169
2170 When called from inside a function with the @qcode{"local"} option, the 2170 When called from inside a function with the @qcode{"local"} option, the
2171 variable is changed locally for the function and any subroutines it calls. 2171 variable is changed locally for the function and any subroutines it calls.