Mercurial > octave-nkf

comparison libinterp/corefcn/getgrent.cc @ 20207:4f45eaf83908 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
comparison
equal deleted inserted replaced
20206:b70f8da6dcd3 20207:4f45eaf83908
64 64
65 DEFUN (getgrent, args, , 65 DEFUN (getgrent, args, ,
66 "-*- texinfo -*-\n\ 66 "-*- texinfo -*-\n\
67 @deftypefn {Built-in Function} {@var{grp_struct} =} getgrent ()\n\ 67 @deftypefn {Built-in Function} {@var{grp_struct} =} getgrent ()\n\
68 Return an entry from the group database, opening it if necessary.\n\ 68 Return an entry from the group database, opening it if necessary.\n\
69 \n\
69 Once the end of data has been reached, @code{getgrent} returns 0.\n\ 70 Once the end of data has been reached, @code{getgrent} returns 0.\n\
71 @seealso{setgrent, endgrent}\n\
70 @end deftypefn") 72 @end deftypefn")
71 { 73 {
72 octave_value_list retval; 74 octave_value_list retval;
73 75
74 retval(1) = std::string (); 76 retval(1) = std::string ();
91 93
92 DEFUN (getgrgid, args, , 94 DEFUN (getgrgid, args, ,
93 "-*- texinfo -*-\n\ 95 "-*- texinfo -*-\n\
94 @deftypefn {Built-in Function} {@var{grp_struct} =} getgrgid (@var{gid}).\n\ 96 @deftypefn {Built-in Function} {@var{grp_struct} =} getgrgid (@var{gid}).\n\
95 Return the first entry from the group database with the group ID\n\ 97 Return the first entry from the group database with the group ID\n\
96 @var{gid}. If the group ID does not exist in the database,\n\ 98 @var{gid}.\n\
97 @code{getgrgid} returns 0.\n\ 99 \n\
100 If the group ID does not exist in the database, @code{getgrgid} returns 0.\n\
101 @seealso{getgrnam}\n\
98 @end deftypefn") 102 @end deftypefn")
99 { 103 {
100 octave_value_list retval; 104 octave_value_list retval;
101 105
102 retval(1) = std::string (); 106 retval(1) = std::string ();
131 135
132 DEFUN (getgrnam, args, , 136 DEFUN (getgrnam, args, ,
133 "-*- texinfo -*-\n\ 137 "-*- texinfo -*-\n\
134 @deftypefn {Built-in Function} {@var{grp_struct} =} getgrnam (@var{name})\n\ 138 @deftypefn {Built-in Function} {@var{grp_struct} =} getgrnam (@var{name})\n\
135 Return the first entry from the group database with the group name\n\ 139 Return the first entry from the group database with the group name\n\
136 @var{name}. If the group name does not exist in the database,\n\ 140 @var{name}.\n\
137 @code{getgrnam} returns 0.\n\ 141 \n\
142 If the group name does not exist in the database, @code{getgrnam} returns 0.\n\
143 @seealso{getgrgid}\n\
138 @end deftypefn") 144 @end deftypefn")
139 { 145 {
140 octave_value_list retval; 146 octave_value_list retval;
141 147
142 retval(1) = std::string (); 148 retval(1) = std::string ();
164 170
165 DEFUN (setgrent, args, , 171 DEFUN (setgrent, args, ,
166 "-*- texinfo -*-\n\ 172 "-*- texinfo -*-\n\
167 @deftypefn {Built-in Function} {} setgrent ()\n\ 173 @deftypefn {Built-in Function} {} setgrent ()\n\
168 Return the internal pointer to the beginning of the group database.\n\ 174 Return the internal pointer to the beginning of the group database.\n\
175 @seealso{getgrent, endgrent}\n\
169 @end deftypefn") 176 @end deftypefn")
170 { 177 {
171 octave_value_list retval; 178 octave_value_list retval;
172 179
173 retval(1) = std::string (); 180 retval(1) = std::string ();
190 197
191 DEFUN (endgrent, args, , 198 DEFUN (endgrent, args, ,
192 "-*- texinfo -*-\n\ 199 "-*- texinfo -*-\n\
193 @deftypefn {Built-in Function} {} endgrent ()\n\ 200 @deftypefn {Built-in Function} {} endgrent ()\n\
194 Close the group database.\n\ 201 Close the group database.\n\
202 @seealso{getgrent, setgrent}\n\
195 @end deftypefn") 203 @end deftypefn")
196 { 204 {
197 octave_value_list retval; 205 octave_value_list retval;
198 206
199 retval(1) = std::string (); 207 retval(1) = std::string ();