Mercurial > octave-libtiff
comparison libinterp/corefcn/getpwent.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 |
|---|---|
| 140 return ovl (val, msg); | 140 return ovl (val, msg); |
| 141 } | 141 } |
| 142 | 142 |
| 143 DEFUN (setpwent, args, , | 143 DEFUN (setpwent, args, , |
| 144 doc: /* -*- texinfo -*- | 144 doc: /* -*- texinfo -*- |
| 145 @deftypefn {} {} setpwent () | 145 @deftypefn {} {[@var{status}, @var{msg}] =} setpwent () |
| 146 Return the internal pointer to the beginning of the password database. | 146 Return the internal pointer to the beginning of the password database. |
| 147 @seealso{getpwent, endpwent} | 147 @seealso{getpwent, endpwent} |
| 148 @end deftypefn */) | 148 @end deftypefn */) |
| 149 { | 149 { |
| 150 if (args.length () != 0) | 150 if (args.length () != 0) |
| 158 return ovl (static_cast<double> (status), msg); | 158 return ovl (static_cast<double> (status), msg); |
| 159 } | 159 } |
| 160 | 160 |
| 161 DEFUN (endpwent, args, , | 161 DEFUN (endpwent, args, , |
| 162 doc: /* -*- texinfo -*- | 162 doc: /* -*- texinfo -*- |
| 163 @deftypefn {} {} endpwent () | 163 @deftypefn {} {[@var{status}, @var{msg}] =} endpwent () |
| 164 Close the password database. | 164 Close the password database. |
| 165 @seealso{getpwent, setpwent} | 165 @seealso{getpwent, setpwent} |
| 166 @end deftypefn */) | 166 @end deftypefn */) |
| 167 { | 167 { |
| 168 if (args.length () != 0) | 168 if (args.length () != 0) |