Mercurial > octave-antonio

comparison libinterp/octave-value/ov-cell.cc @ 20163:075a5e2e1ba5 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 build-aux, libinterp/dldfcn, libinterp/octave-value, libinterp/parse-tree directories. * build-aux/mk-opts.pl, libinterp/dldfcn/__magick_read__.cc, libinterp/dldfcn/amd.cc, libinterp/dldfcn/audiodevinfo.cc, libinterp/dldfcn/audioread.cc, libinterp/dldfcn/ccolamd.cc, libinterp/dldfcn/chol.cc, libinterp/dldfcn/colamd.cc, libinterp/dldfcn/convhulln.cc, libinterp/dldfcn/dmperm.cc, libinterp/dldfcn/fftw.cc, libinterp/dldfcn/qr.cc, libinterp/dldfcn/symbfact.cc, libinterp/dldfcn/symrcm.cc, libinterp/octave-value/ov-base.cc, libinterp/octave-value/ov-bool-mat.cc, libinterp/octave-value/ov-cell.cc, libinterp/octave-value/ov-class.cc, libinterp/octave-value/ov-fcn-handle.cc, libinterp/octave-value/ov-fcn-inline.cc, libinterp/octave-value/ov-java.cc, libinterp/octave-value/ov-null-mat.cc, libinterp/octave-value/ov-oncleanup.cc, libinterp/octave-value/ov-range.cc, libinterp/octave-value/ov-struct.cc, libinterp/octave-value/ov-typeinfo.cc, libinterp/octave-value/ov-usr-fcn.cc, libinterp/octave-value/ov.cc, libinterp/parse-tree/lex.ll, libinterp/parse-tree/oct-parse.in.yy, libinterp/parse-tree/pt-binop.cc, libinterp/parse-tree/pt-eval.cc, libinterp/parse-tree/pt-mat.cc: doc: Update more docstrings to have one sentence summary as first line.
author Rik <rik@octave.org>
date Sun, 03 May 2015 21:52:42 -0700
parents 09ed6f7538dd
children
comparison
equal deleted inserted replaced
20162:2645f9ef8c88 20163:075a5e2e1ba5
1299 @deftypefnx {Built-in Function} {} cell (@var{m}, @var{n}, @var{k}, @dots{})\n\ 1299 @deftypefnx {Built-in Function} {} cell (@var{m}, @var{n}, @var{k}, @dots{})\n\
1300 @deftypefnx {Built-in Function} {} cell ([@var{m} @var{n} @dots{}])\n\ 1300 @deftypefnx {Built-in Function} {} cell ([@var{m} @var{n} @dots{}])\n\
1301 Create a new cell array object.\n\ 1301 Create a new cell array object.\n\
1302 \n\ 1302 \n\
1303 If invoked with a single scalar integer argument, return a square\n\ 1303 If invoked with a single scalar integer argument, return a square\n\
1304 @nospell{NxN} cell array. If invoked with two or more scalar\n\ 1304 @nospell{NxN} cell array. If invoked with two or more scalar integer\n\
1305 integer arguments, or a vector of integer values, return an array with\n\ 1305 arguments, or a vector of integer values, return an array with the given\n\
1306 the given dimensions.\n\ 1306 dimensions.\n\
1307 @seealso{cellstr, mat2cell, num2cell, struct2cell}\n\ 1307 @seealso{cellstr, mat2cell, num2cell, struct2cell}\n\
1308 @end deftypefn") 1308 @end deftypefn")
1309 { 1309 {
1310 octave_value retval; 1310 octave_value retval;
1311 1311
1355 } 1355 }
1356 1356
1357 DEFUN (iscellstr, args, , 1357 DEFUN (iscellstr, args, ,
1358 "-*- texinfo -*-\n\ 1358 "-*- texinfo -*-\n\
1359 @deftypefn {Built-in Function} {} iscellstr (@var{cell})\n\ 1359 @deftypefn {Built-in Function} {} iscellstr (@var{cell})\n\
1360 Return true if every element of the cell array @var{cell} is a\n\ 1360 Return true if every element of the cell array @var{cell} is a character\n\
1361 character string.\n\ 1361 string.\n\
1362 @seealso{ischar}\n\ 1362 @seealso{ischar}\n\
1363 @end deftypefn") 1363 @end deftypefn")
1364 { 1364 {
1365 octave_value retval; 1365 octave_value retval;
1366 1366
1378 // declaration) and so we don't have to use feval to call it. 1378 // declaration) and so we don't have to use feval to call it.
1379 1379
1380 DEFUN (cellstr, args, , 1380 DEFUN (cellstr, args, ,
1381 "-*- texinfo -*-\n\ 1381 "-*- texinfo -*-\n\
1382 @deftypefn {Built-in Function} {@var{cstr} =} cellstr (@var{strmat})\n\ 1382 @deftypefn {Built-in Function} {@var{cstr} =} cellstr (@var{strmat})\n\
1383 Create a new cell array object from the elements of the string\n\ 1383 Create a new cell array object from the elements of the string array\n\
1384 array @var{strmat}.\n\ 1384 @var{strmat}.\n\
1385 \n\ 1385 \n\
1386 Each row of @var{strmat} becomes an element of @var{cstr}. Any trailing\n\ 1386 Each row of @var{strmat} becomes an element of @var{cstr}. Any trailing\n\
1387 spaces in a row are deleted before conversion.\n\ 1387 spaces in a row are deleted before conversion.\n\
1388 \n\ 1388 \n\
1389 To convert back from a cellstr to a character array use @code{char}.\n\ 1389 To convert back from a cellstr to a character array use @code{char}.\n\
1418 1418
1419 DEFUN (struct2cell, args, , 1419 DEFUN (struct2cell, args, ,
1420 "-*- texinfo -*-\n\ 1420 "-*- texinfo -*-\n\
1421 @deftypefn {Built-in Function} {@var{c} =} struct2cell (@var{s})\n\ 1421 @deftypefn {Built-in Function} {@var{c} =} struct2cell (@var{s})\n\
1422 Create a new cell array from the objects stored in the struct object.\n\ 1422 Create a new cell array from the objects stored in the struct object.\n\
1423 If @var{f} is the number of fields in the structure, the resulting\n\ 1423 \n\
1424 cell array will have a dimension vector corresponding to\n\ 1424 If @var{f} is the number of fields in the structure, the resulting cell\n\
1425 array will have a dimension vector corresponding to\n\
1425 @code{[@var{f} size(@var{s})]}. For example:\n\ 1426 @code{[@var{f} size(@var{s})]}. For example:\n\
1426 \n\ 1427 \n\
1427 @example\n\ 1428 @example\n\
1428 @group\n\ 1429 @group\n\
1429 s = struct (\"name\", @{\"Peter\", \"Hannah\", \"Robert\"@},\n\ 1430 s = struct (\"name\", @{\"Peter\", \"Hannah\", \"Robert\"@},\n\