Mercurial > octave-nkf
diff libinterp/corefcn/strfns.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 | 5212cda4ac0e aa36fb998a4d |
line wrap: on
line diff
--- a/libinterp/corefcn/strfns.cc Thu May 07 17:16:36 2015 -0400 +++ b/libinterp/corefcn/strfns.cc Sat May 09 17:19:30 2015 -0700 @@ -47,19 +47,19 @@ @deftypefnx {Built-in Function} {} char (@var{s1}, @var{s2}, @dots{})\n\ @deftypefnx {Built-in Function} {} char (@var{cell_array})\n\ Create a string array from one or more numeric matrices, character\n\ -matrices, or cell arrays. Arguments are concatenated vertically.\n\ -The returned values are padded with blanks as needed to make each row\n\ -of the string array have the same length. Empty input strings are\n\ -significant and will concatenated in the output.\n\ +matrices, or cell arrays.\n\ \n\ -For numerical input, each element is converted\n\ -to the corresponding ASCII character. A range error results if an input\n\ -is outside the ASCII range (0-255).\n\ +Arguments are concatenated vertically. The returned values are padded with\n\ +blanks as needed to make each row of the string array have the same length. \n\ +Empty input strings are significant and will concatenated in the output.\n\ +\n\ +For numerical input, each element is converted to the corresponding ASCII\n\ +character. A range error results if an input is outside the ASCII range\n\ +(0-255).\n\ \n\ For cell arrays, each element is concatenated separately. Cell arrays\n\ -converted through\n\ -@code{char} can mostly be converted back with @code{cellstr}.\n\ -For example:\n\ +converted through @code{char} can mostly be converted back with\n\ +@code{cellstr}. For example:\n\ \n\ @example\n\ @group\n\ @@ -178,19 +178,20 @@ @deftypefnx {Built-in Function} {} strvcat (@var{s1}, @var{s2}, @dots{})\n\ @deftypefnx {Built-in Function} {} strvcat (@var{cell_array})\n\ Create a character array from one or more numeric matrices, character\n\ -matrices, or cell arrays. Arguments are concatenated vertically.\n\ -The returned values are padded with blanks as needed to make each row\n\ -of the string array have the same length. Unlike @code{char}, empty\n\ -strings are removed and will not appear in the output.\n\ +matrices, or cell arrays.\n\ \n\ -For numerical input, each element is converted\n\ -to the corresponding ASCII character. A range error results if an input\n\ -is outside the ASCII range (0-255).\n\ +Arguments are concatenated vertically. The returned values are padded with\n\ +blanks as needed to make each row of the string array have the same length. \n\ +Unlike @code{char}, empty strings are removed and will not appear in the\n\ +output.\n\ +\n\ +For numerical input, each element is converted to the corresponding ASCII\n\ +character. A range error results if an input is outside the ASCII range\n\ +(0-255).\n\ \n\ For cell arrays, each element is concatenated separately. Cell arrays\n\ -converted through\n\ -@code{strvcat} can mostly be converted back with @code{cellstr}.\n\ -For example:\n\ +converted through @code{strvcat} can mostly be converted back with\n\ +@code{cellstr}. For example:\n\ \n\ @example\n\ @group\n\ @@ -870,14 +871,15 @@ DEFUN (list_in_columns, args, , "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} list_in_columns (@var{arg}, @var{width}, @var{prefix})\n\ -Return a string containing the elements of @var{arg} listed in\n\ -columns with an overall maximum width of @var{width} and optional\n\ -prefix @var{prefix}. The argument @var{arg} must be a cell array\n\ -of character strings or a character array. If @var{width} is not\n\ -specified or is an empty matrix, or less than or equal to zero,\n\ -the width of the terminal screen is used.\n\ -Newline characters are used to break the lines in the output string.\n\ -For example:\n\ +Return a string containing the elements of @var{arg} listed in columns with\n\ +an overall maximum width of @var{width} and optional prefix @var{prefix}.\n\ +\n\ +The argument @var{arg} must be a cell array of character strings or a\n\ +character array.\n\ +\n\ +If @var{width} is not specified or is an empty matrix, or less than or equal\n\ +to zero, the width of the terminal screen is used. Newline characters are\n\ +used to break the lines in the output string. For example:\n\ @c Set example in small font to prevent overfull line\n\ \n\ @smallexample\n\