Mercurial > octave-libtiff
comparison libinterp/corefcn/settings.cc @ 30888:32d2b6604a9f
doc: Ensure documentation lists output argument when it exists for functions in libinterp/
For new users of Octave it is best to show explicit calling forms
in the documentation and to show a return argument when it exists.
* __ftp__.cc, __magick_read__.cc, __pchip_deriv__.cc, bitfcns.cc, bsxfun.cc,
call-stack.cc, cellfun.cc, chol.cc, conv2.cc, data.cc, debug.cc, defaults.cc,
det.cc, dirfns.cc, display.cc, dot.cc, error.cc, event-manager.cc, fft.cc,
fft2.cc, fftn.cc, file-io.cc, getgrent.cc, getpwent.cc, getrusage.cc,
graphics.cc, hash.cc, help.cc, input.cc, interpreter.cc, kron.cc, load-path.cc,
mappers.cc, max.cc, nproc.cc, oct-hist.cc, pager.cc, pinv.cc, psi.cc, rand.cc,
settings.cc, sighandlers.cc, stream-euler.cc, strfns.cc, symtab.cc,
syscalls.cc, sysdep.cc, time.cc, toplev.cc, utils.cc, variables.cc,
__fltk_uigetfile__.cc, audiodevinfo.cc, audioread.cc, fftw.cc, ov-bool-mat.cc,
ov-cell.cc, ov-class.cc, ov-classdef.cc, ov-fcn-handle.cc, ov-java.cc,
ov-struct.cc, ov-typeinfo.cc, ov-usr-fcn.cc, ov.cc, octave.cc, profiler.cc:
Add return arguments to @deftypefn macros where they were missing.
Attempt to use standard naming convention for return variables.
Occasionally improved the docstring itself by re-wording or adding code
examples.
| author | Rik <rik@octave.org> |
|---|---|
| date | Mon, 04 Apr 2022 10:31:48 -0700 |
| parents | 796f54d4ddbf |
| children |
comparison
equal
deleted
inserted
replaced
| 30887:4bab8d3fce79 | 30888:32d2b6604a9f |
|---|---|
| 55 "__lexer_debug_flag__"); | 55 "__lexer_debug_flag__"); |
| 56 } | 56 } |
| 57 | 57 |
| 58 DEFMETHOD (__display_tokens__, interp, args, nargout, | 58 DEFMETHOD (__display_tokens__, interp, args, nargout, |
| 59 doc: /* -*- texinfo -*- | 59 doc: /* -*- texinfo -*- |
| 60 @deftypefn {} {} __display_tokens__ () | 60 @deftypefn {} {@var{val} =} __display_tokens__ () |
| 61 @deftypefnx {} {@var{old_val} =} __display_tokens__ (@var{new_val}) | |
| 62 @deftypefnx {} {@var{old_val} =} __display_tokens__ (@var{new_val}, "local") | |
| 61 Query or set the internal variable that determines whether Octave's | 63 Query or set the internal variable that determines whether Octave's |
| 62 lexer displays tokens as they are read. | 64 lexer displays tokens as they are read. |
| 63 @seealso{__lexer_debug_flag__, __token_count__} | 65 @seealso{__lexer_debug_flag__, __token_count__} |
| 64 @end deftypefn */) | 66 @end deftypefn */) |
| 65 { | 67 { |
| 68 return stgs.display_tokens (args, nargout); | 70 return stgs.display_tokens (args, nargout); |
| 69 } | 71 } |
| 70 | 72 |
| 71 DEFMETHOD (__token_count__, interp, , , | 73 DEFMETHOD (__token_count__, interp, , , |
| 72 doc: /* -*- texinfo -*- | 74 doc: /* -*- texinfo -*- |
| 73 @deftypefn {} {} __token_count__ () | 75 @deftypefn {} {@var{n} =} __token_count__ () |
| 74 Return the number of language tokens processed since Octave startup. | 76 Return the number of language tokens processed since Octave startup. |
| 75 @seealso{__lexer_debug_flag__, __display_tokens__} | 77 @seealso{__lexer_debug_flag__, __display_tokens__} |
| 76 @end deftypefn */) | 78 @end deftypefn */) |
| 77 { | 79 { |
| 78 settings& stgs = interp.get_settings (); | 80 settings& stgs = interp.get_settings (); |