comparison libinterp/corefcn/call-stack.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 ed17822e7662
children e88a07dec498
comparison
equal deleted inserted replaced
30887:4bab8d3fce79 30888:32d2b6604a9f
1172 DEFMETHOD (who, interp, args, nargout, 1172 DEFMETHOD (who, interp, args, nargout,
1173 doc: /* -*- texinfo -*- 1173 doc: /* -*- texinfo -*-
1174 @deftypefn {} {} who 1174 @deftypefn {} {} who
1175 @deftypefnx {} {} who pattern @dots{} 1175 @deftypefnx {} {} who pattern @dots{}
1176 @deftypefnx {} {} who option pattern @dots{} 1176 @deftypefnx {} {} who option pattern @dots{}
1177 @deftypefnx {} {C =} who ("pattern", @dots{}) 1177 @deftypefnx {} {C =} who (@dots{})
1178 List currently defined variables matching the given patterns. 1178 List currently defined variables matching the given patterns.
1179 1179
1180 Valid pattern syntax is the same as described for the @code{clear} command. 1180 Valid pattern syntax is the same as described for the @code{clear} command.
1181 If no patterns are supplied, all variables are listed. 1181 If no patterns are supplied, all variables are listed.
1182 1182