Mercurial > octave
view 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 | e88a07dec498 |
line wrap: on
line source
//////////////////////////////////////////////////////////////////////// // // Copyright (C) 2018-2022 The Octave Project Developers // // See the file COPYRIGHT.md in the top-level directory of this // distribution or <https://octave.org/copyright/>. // // This file is part of Octave. // // Octave is free software: you can redistribute it and/or modify it // under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // // Octave is distributed in the hope that it will be useful, but // WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // // You should have received a copy of the GNU General Public License // along with Octave; see the file COPYING. If not, see // <https://www.gnu.org/licenses/>. // //////////////////////////////////////////////////////////////////////// #if defined (HAVE_CONFIG_H) # include "config.h" #endif #include "defun.h" #include "interpreter.h" #include "ov.h" #include "ovl.h" #include "settings.h" #include "variables.h" OCTAVE_NAMESPACE_BEGIN settings::settings (void) : m_display_tokens (false), m_token_count (0), m_lexer_debug_flag (false) { } octave_value settings::display_tokens (const octave_value_list& args, int nargout) { return set_internal_variable (m_display_tokens, args, nargout, "__display_tokens__"); } octave_value settings::lexer_debug_flag (const octave_value_list& args, int nargout) { return set_internal_variable (m_lexer_debug_flag, args, nargout, "__lexer_debug_flag__"); } DEFMETHOD (__display_tokens__, interp, args, nargout, doc: /* -*- texinfo -*- @deftypefn {} {@var{val} =} __display_tokens__ () @deftypefnx {} {@var{old_val} =} __display_tokens__ (@var{new_val}) @deftypefnx {} {@var{old_val} =} __display_tokens__ (@var{new_val}, "local") Query or set the internal variable that determines whether Octave's lexer displays tokens as they are read. @seealso{__lexer_debug_flag__, __token_count__} @end deftypefn */) { settings& stgs = interp.get_settings (); return stgs.display_tokens (args, nargout); } DEFMETHOD (__token_count__, interp, , , doc: /* -*- texinfo -*- @deftypefn {} {@var{n} =} __token_count__ () Return the number of language tokens processed since Octave startup. @seealso{__lexer_debug_flag__, __display_tokens__} @end deftypefn */) { settings& stgs = interp.get_settings (); return octave_value (stgs.token_count ()); } DEFMETHOD (__lexer_debug_flag__, interp, args, nargout, doc: /* -*- texinfo -*- @deftypefn {} {@var{val} =} __lexer_debug_flag__ () @deftypefnx {} {@var{old_val} =} __lexer_debug_flag__ (@var{new_val}) Query or set the internal flag that determines whether Octave's lexer prints debug information as it processes an expression. @seealso{__display_tokens__, __token_count__, __parse_debug_flag__} @end deftypefn */) { settings& stgs = interp.get_settings (); return stgs.lexer_debug_flag (args, nargout); } OCTAVE_NAMESPACE_END