Mercurial > octave
view libinterp/corefcn/getgrent.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) 1996-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 <string> #include <sys/types.h> #include "oct-group.h" #include "defun.h" #include "error.h" #include "errwarn.h" #include "oct-map.h" #include "ov.h" #include "ovl.h" #include "utils.h" OCTAVE_NAMESPACE_BEGIN // Group file functions. (Why not?) static octave_value mk_gr_map (const sys::group& gr) { if (gr) { octave_scalar_map m; m.assign ("name", gr.name ()); m.assign ("passwd", gr.passwd ()); m.assign ("gid", static_cast<double> (gr.gid ())); m.assign ("mem", octave_value (gr.mem ())); return octave_value (m); } else return octave_value (0); } DEFUN (getgrent, args, , doc: /* -*- texinfo -*- @deftypefn {} {@var{grp_struct} =} getgrent () Return an entry from the group database, opening it if necessary. Once the end of data has been reached, @code{getgrent} returns 0. @seealso{setgrent, endgrent} @end deftypefn */) { if (args.length () != 0) print_usage (); std::string msg; // sys::group::getgrent may set msg. octave_value val = mk_gr_map (sys::group::getgrent (msg)); return ovl (val, msg); } DEFUN (getgrgid, args, , doc: /* -*- texinfo -*- @deftypefn {} {@var{grp_struct} =} getgrgid (@var{gid}). Return the first entry from the group database with the group ID @var{gid}. If the group ID does not exist in the database, @code{getgrgid} returns 0. @seealso{getgrnam} @end deftypefn */) { if (args.length () != 1) print_usage (); double dval = args(0).double_value (); if (math::x_nint (dval) != dval) error ("getgrgid: GID must be an integer"); gid_t gid = static_cast<gid_t> (dval); std::string msg; // sys::group::getgrgid may set msg. octave_value val = mk_gr_map (sys::group::getgrgid (gid, msg)); return ovl (val, msg); } DEFUN (getgrnam, args, , doc: /* -*- texinfo -*- @deftypefn {} {@var{grp_struct} =} getgrnam (@var{name}) Return the first entry from the group database with the group name @var{name}. If the group name does not exist in the database, @code{getgrnam} returns 0. @seealso{getgrgid} @end deftypefn */) { if (args.length () != 1) print_usage (); std::string s = args(0).string_value (); std::string msg; // sys::group::getgrnam may set msg. octave_value val = mk_gr_map (sys::group::getgrnam (s.c_str (), msg)); return ovl (val, msg); } DEFUN (setgrent, args, , doc: /* -*- texinfo -*- @deftypefn {} {[@var{status}, @var{msg}] =} setgrent () Return the internal pointer to the beginning of the group database. @seealso{getgrent, endgrent} @end deftypefn */) { if (args.length () != 0) print_usage (); std::string msg; // sys::group::setgrent may set msg. int status = sys::group::setgrent (msg); return ovl (static_cast<double> (status), msg); } DEFUN (endgrent, args, , doc: /* -*- texinfo -*- @deftypefn {} {[@var{status}, @var{msg}] =} endgrent () Close the group database. @seealso{getgrent, setgrent} @end deftypefn */) { if (args.length () != 0) print_usage (); std::string msg; // sys::group::endgrent may set msg. int status = sys::group::endgrent (msg); return ovl (static_cast<double> (status), msg); } OCTAVE_NAMESPACE_END