Mercurial > octave
diff libinterp/corefcn/help.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 | 32d2b6604a9f |
line wrap: on
line diff
--- a/libinterp/corefcn/help.cc Fri Dec 31 18:44:26 2021 +0100 +++ b/libinterp/corefcn/help.cc Sat Jan 01 19:43:52 2022 -0800 @@ -955,7 +955,7 @@ doc: /* -*- texinfo -*- @deftypefn {} {@var{val} =} built_in_docstrings_file () @deftypefnx {} {@var{old_val} =} built_in_docstrings_file (@var{new_val}) -@deftypefnx {} {} built_in_docstrings_file (@var{new_val}, "local") +@deftypefnx {} {@var{old_val} =} built_in_docstrings_file (@var{new_val}, "local") Query or set the internal variable that specifies the name of the file containing docstrings for built-in Octave functions. @@ -980,7 +980,7 @@ doc: /* -*- texinfo -*- @deftypefn {} {@var{val} =} doc_cache_file () @deftypefnx {} {@var{old_val} =} doc_cache_file (@var{new_val}) -@deftypefnx {} {} doc_cache_file (@var{new_val}, "local") +@deftypefnx {} {@var{old_val} =} doc_cache_file (@var{new_val}, "local") Query or set the internal variable that specifies the name of the Octave documentation cache file. @@ -1009,7 +1009,7 @@ doc: /* -*- texinfo -*- @deftypefn {} {@var{val} =} info_file () @deftypefnx {} {@var{old_val} =} info_file (@var{new_val}) -@deftypefnx {} {} info_file (@var{new_val}, "local") +@deftypefnx {} {@var{old_val} =} info_file (@var{new_val}, "local") Query or set the internal variable that specifies the name of the Octave info file. @@ -1035,7 +1035,7 @@ doc: /* -*- texinfo -*- @deftypefn {} {@var{val} =} info_program () @deftypefnx {} {@var{old_val} =} info_program (@var{new_val}) -@deftypefnx {} {} info_program (@var{new_val}, "local") +@deftypefnx {} {@var{old_val} =} info_program (@var{new_val}, "local") Query or set the internal variable that specifies the name of the info program to run. @@ -1058,7 +1058,7 @@ doc: /* -*- texinfo -*- @deftypefn {} {@var{val} =} makeinfo_program () @deftypefnx {} {@var{old_val} =} makeinfo_program (@var{new_val}) -@deftypefnx {} {} makeinfo_program (@var{new_val}, "local") +@deftypefnx {} {@var{old_val} =} makeinfo_program (@var{new_val}, "local") Query or set the internal variable that specifies the name of the program that Octave runs to format help text containing Texinfo markup commands. @@ -1080,7 +1080,7 @@ doc: /* -*- texinfo -*- @deftypefn {} {@var{val} =} suppress_verbose_help_message () @deftypefnx {} {@var{old_val} =} suppress_verbose_help_message (@var{new_val}) -@deftypefnx {} {} suppress_verbose_help_message (@var{new_val}, "local") +@deftypefnx {} {@var{old_val} =} suppress_verbose_help_message (@var{new_val}, "local") Query or set the internal variable that controls whether Octave will add additional help information to the end of the output from the @code{help} command and usage messages for built-in commands. @@ -1099,7 +1099,7 @@ doc: /* -*- texinfo -*- @deftypefn {} {@var{val} =} texi_macros_file () @deftypefnx {} {@var{old_val} =} texi_macros_file (@var{new_val}) -@deftypefnx {} {} texi_macros_file (@var{new_val}, "local") +@deftypefnx {} {@var{old_val} =} texi_macros_file (@var{new_val}, "local") Query or set the internal variable that specifies the name of the file containing Texinfo macros that are prepended to documentation strings before they are passed to makeinfo.