Mercurial > octave-nkf
diff libinterp/corefcn/cellfun.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 | 19755f4fc851 |
children | a9574e3c6e9e |
line wrap: on
line diff
--- a/libinterp/corefcn/cellfun.cc Thu May 07 17:16:36 2015 -0400 +++ b/libinterp/corefcn/cellfun.cc Sat May 09 17:19:30 2015 -0700 @@ -283,8 +283,10 @@ @deftypefnx {Built-in Function} {} cellfun (@dots{}, \"UniformOutput\", @var{val})\n\ \n\ Evaluate the function named @var{name} on the elements of the cell array\n\ -@var{C}. Elements in @var{C} are passed on to the named function\n\ -individually. The function @var{name} can be one of the functions\n\ +@var{C}.\n\ +\n\ +Elements in @var{C} are passed on to the named function individually. The\n\ +function @var{name} can be one of the functions\n\ \n\ @table @code\n\ @item isempty\n\ @@ -320,7 +322,7 @@ Additionally, @code{cellfun} accepts an arbitrary function @var{func}\n\ in the form of an inline function, function handle, or the name of a\n\ function (in a character string). The function can take one or more\n\ -arguments, with the inputs arguments given by @var{C}, @var{D}, etc. \n\ +arguments, with the inputs arguments given by @var{C}, @var{D}, etc.\n\ Equally the function can return one or more output arguments. For example:\n\ \n\ @example\n\ @@ -1066,9 +1068,11 @@ @deftypefnx {Function File} {} arrayfun (@dots{}, \"UniformOutput\", @var{val})\n\ @deftypefnx {Function File} {} arrayfun (@dots{}, \"ErrorHandler\", @var{errfunc})\n\ \n\ -Execute a function on each element of an array. This is useful for\n\ -functions that do not accept array arguments. If the function does\n\ -accept array arguments it is better to call the function directly.\n\ +Execute a function on each element of an array.\n\ +\n\ +This is useful for functions that do not accept array arguments. If the\n\ +function does accept array arguments it is better to call the function\n\ +directly.\n\ \n\ The first input argument @var{func} can be a string, a function\n\ handle, an inline function, or an anonymous function. The input\n\ @@ -1863,9 +1867,11 @@ "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {@var{C} =} num2cell (@var{A})\n\ @deftypefnx {Built-in Function} {@var{C} =} num2cell (@var{A}, @var{dim})\n\ -Convert the numeric matrix @var{A} to a cell array. If @var{dim} is\n\ -defined, the value @var{C} is of dimension 1 in this dimension and the\n\ -elements of @var{A} are placed into @var{C} in slices. For example:\n\ +Convert the numeric matrix @var{A} to a cell array.\n\ +\n\ +If @var{dim} is defined, the value @var{C} is of dimension 1 in this\n\ +dimension and the elements of @var{A} are placed into @var{C} in slices.\n\ +For example:\n\ \n\ @example\n\ @group\n\ @@ -2194,12 +2200,14 @@ @deftypefn {Built-in Function} {@var{C} =} mat2cell (@var{A}, @var{m}, @var{n})\n\ @deftypefnx {Built-in Function} {@var{C} =} mat2cell (@var{A}, @var{d1}, @var{d2}, @dots{})\n\ @deftypefnx {Built-in Function} {@var{C} =} mat2cell (@var{A}, @var{r})\n\ -Convert the matrix @var{A} to a cell array. If @var{A} is 2-D, then\n\ -it is required that @code{sum (@var{m}) == size (@var{A}, 1)} and\n\ +Convert the matrix @var{A} to a cell array.\n\ +\n\ +If @var{A} is 2-D, then it is required that\n\ +@code{sum (@var{m}) == size (@var{A}, 1)} and\n\ @code{sum (@var{n}) == size (@var{A}, 2)}. Similarly, if @var{A} is\n\ -multi-dimensional and the number of dimensional arguments is equal\n\ -to the dimensions of @var{A}, then it is required that @code{sum (@var{di})\n\ -== size (@var{A}, i)}.\n\ +multi-dimensional and the number of dimensional arguments is equal to the\n\ +dimensions of @var{A}, then it is required that\n\ +@code{sum (@var{di}) == size (@var{A}, i)}.\n\ \n\ Given a single dimensional argument @var{r}, the other dimensional\n\ arguments are assumed to equal @code{size (@var{A},@var{i})}.\n\ @@ -2365,8 +2373,9 @@ @deftypefn {Built-in Function} {@var{sl} =} cellslices (@var{x}, @var{lb}, @var{ub}, @var{dim})\n\ Given an array @var{x}, this function produces a cell array of slices from\n\ the array determined by the index vectors @var{lb}, @var{ub}, for lower and\n\ -upper bounds, respectively. In other words, it is equivalent to the\n\ -following code:\n\ +upper bounds, respectively.\n\ +\n\ +In other words, it is equivalent to the following code:\n\ \n\ @example\n\ @group\n\ @@ -2498,6 +2507,8 @@ DEFUN (cellindexmat, args, , "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {@var{y} =} cellindexmat (@var{x}, @var{varargin})\n\ +Perform indexing of matrices in a cell array.\n\ +\n\ Given a cell array of matrices @var{x}, this function computes\n\ \n\ @example\n\