Mercurial > octave-nkf
view libinterp/corefcn/getgrent.cc @ 20207:4f45eaf83908 stable
doc: Update more docstrings to have one sentence summary as first line.
Reviewed libinterp/corefcn directory.
* libinterp/corefcn/__ilu__.cc, libinterp/corefcn/balance.cc,
libinterp/corefcn/besselj.cc, libinterp/corefcn/betainc.cc,
libinterp/corefcn/bitfcns.cc, libinterp/corefcn/bsxfun.cc,
libinterp/corefcn/cellfun.cc, libinterp/corefcn/colloc.cc,
libinterp/corefcn/conv2.cc, libinterp/corefcn/data.cc,
libinterp/corefcn/debug.cc, libinterp/corefcn/defaults.cc,
libinterp/corefcn/det.cc, libinterp/corefcn/dirfns.cc,
libinterp/corefcn/dlmread.cc, libinterp/corefcn/dot.cc,
libinterp/corefcn/eig.cc, libinterp/corefcn/error.cc,
libinterp/corefcn/fft2.cc, libinterp/corefcn/fftn.cc,
libinterp/corefcn/file-io.cc, libinterp/corefcn/filter.cc,
libinterp/corefcn/find.cc, libinterp/corefcn/gammainc.cc,
libinterp/corefcn/gcd.cc, libinterp/corefcn/getgrent.cc,
libinterp/corefcn/getpwent.cc, libinterp/corefcn/getrusage.cc,
libinterp/corefcn/graphics.cc, libinterp/corefcn/help.cc,
libinterp/corefcn/hex2num.cc, libinterp/corefcn/input.cc,
libinterp/corefcn/inv.cc, libinterp/corefcn/kron.cc,
libinterp/corefcn/load-path.cc, libinterp/corefcn/load-save.cc,
libinterp/corefcn/lookup.cc, libinterp/corefcn/ls-oct-ascii.cc,
libinterp/corefcn/lsode.cc, libinterp/corefcn/lu.cc,
libinterp/corefcn/luinc.cc, libinterp/corefcn/mappers.cc,
libinterp/corefcn/matrix_type.cc, libinterp/corefcn/max.cc,
libinterp/corefcn/md5sum.cc, libinterp/corefcn/mgorth.cc,
libinterp/corefcn/nproc.cc, libinterp/corefcn/oct-hist.cc,
libinterp/corefcn/ordschur.cc, libinterp/corefcn/pager.cc,
libinterp/corefcn/pinv.cc, libinterp/corefcn/pr-output.cc,
libinterp/corefcn/pt-jit.cc, libinterp/corefcn/quad.cc,
libinterp/corefcn/quadcc.cc, libinterp/corefcn/qz.cc,
libinterp/corefcn/rand.cc, libinterp/corefcn/rcond.cc,
libinterp/corefcn/regexp.cc, libinterp/corefcn/schur.cc,
libinterp/corefcn/sighandlers.cc, libinterp/corefcn/sparse.cc,
libinterp/corefcn/spparms.cc, libinterp/corefcn/str2double.cc,
libinterp/corefcn/strfind.cc, libinterp/corefcn/strfns.cc,
libinterp/corefcn/sub2ind.cc, libinterp/corefcn/svd.cc,
libinterp/corefcn/symtab.cc, libinterp/corefcn/syscalls.cc,
libinterp/corefcn/sysdep.cc, libinterp/corefcn/time.cc,
libinterp/corefcn/toplev.cc, libinterp/corefcn/tril.cc,
libinterp/corefcn/tsearch.cc, libinterp/corefcn/typecast.cc,
libinterp/corefcn/urlwrite.cc, libinterp/corefcn/utils.cc,
libinterp/corefcn/variables.cc, scripts/polynomial/spline.m:
Update more docstrings to have one sentence summary as first line.
author | Rik <rik@octave.org> |
---|---|
date | Sat, 09 May 2015 17:19:30 -0700 |
parents | 4197fc428c7d |
children | f90c8372b7ba |
line wrap: on
line source
/* Copyright (C) 1996-2015 John W. Eaton 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 <http://www.gnu.org/licenses/>. */ #ifdef HAVE_CONFIG_H #include <config.h> #endif #include <string> #include <sys/types.h> #include "oct-group.h" #include "defun.h" #include "error.h" #include "gripes.h" #include "oct-map.h" #include "ov.h" #include "oct-obj.h" #include "utils.h" // Group file functions. (Why not?) static octave_value mk_gr_map (const octave_group& gr) { octave_value retval; 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 ())); retval = m; } else retval = 0; return retval; } DEFUN (getgrent, args, , "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {@var{grp_struct} =} getgrent ()\n\ Return an entry from the group database, opening it if necessary.\n\ \n\ Once the end of data has been reached, @code{getgrent} returns 0.\n\ @seealso{setgrent, endgrent}\n\ @end deftypefn") { octave_value_list retval; retval(1) = std::string (); retval(0) = 0; int nargin = args.length (); if (nargin == 0) { std::string msg; retval(1) = msg; retval(0) = mk_gr_map (octave_group::getgrent (msg)); } else print_usage (); return retval; } DEFUN (getgrgid, args, , "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {@var{grp_struct} =} getgrgid (@var{gid}).\n\ Return the first entry from the group database with the group ID\n\ @var{gid}.\n\ \n\ If the group ID does not exist in the database, @code{getgrgid} returns 0.\n\ @seealso{getgrnam}\n\ @end deftypefn") { octave_value_list retval; retval(1) = std::string (); retval(0) = 0; int nargin = args.length (); if (nargin == 1) { double dval = args(0).double_value (); if (! error_state) { if (D_NINT (dval) == dval) { gid_t gid = static_cast<gid_t> (dval); std::string msg; retval(1) = msg; retval(0) = mk_gr_map (octave_group::getgrgid (gid, msg)); } else error ("getgrgid: GID must be an integer"); } } else print_usage (); return retval; } DEFUN (getgrnam, args, , "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {@var{grp_struct} =} getgrnam (@var{name})\n\ Return the first entry from the group database with the group name\n\ @var{name}.\n\ \n\ If the group name does not exist in the database, @code{getgrnam} returns 0.\n\ @seealso{getgrgid}\n\ @end deftypefn") { octave_value_list retval; retval(1) = std::string (); retval(0) = 0; int nargin = args.length (); if (nargin == 1) { std::string s = args(0).string_value (); if (! error_state) { std::string msg; retval(1) = msg; retval(0) = mk_gr_map (octave_group::getgrnam (s.c_str (), msg)); } } else print_usage (); return retval; } DEFUN (setgrent, args, , "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} setgrent ()\n\ Return the internal pointer to the beginning of the group database.\n\ @seealso{getgrent, endgrent}\n\ @end deftypefn") { octave_value_list retval; retval(1) = std::string (); retval(0) = -1.0; int nargin = args.length (); if (nargin == 0) { std::string msg; retval(1) = msg; retval(0) = static_cast<double> (octave_group::setgrent (msg)); } else print_usage (); return retval; } DEFUN (endgrent, args, , "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} endgrent ()\n\ Close the group database.\n\ @seealso{getgrent, setgrent}\n\ @end deftypefn") { octave_value_list retval; retval(1) = std::string (); retval(0) = -1.0; int nargin = args.length (); if (nargin == 0) { std::string msg; retval(1) = msg; retval(0) = static_cast<double> (octave_group::endgrent (msg)); } else print_usage (); return retval; }