Mercurial > octave

comparison libinterp/octave-value/ov-cell.cc @ 20853:1142cf6abc0d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
2015 Code Sprint: remove class of function from docstring for all C++ files.
author Rik <rik@octave.org>
date Sat, 12 Dec 2015 07:40:03 -0800
parents cef0448a6ed2
children 5357423bca0a
comparison
equal deleted inserted replaced
20852:516bb87ea72e 20853:1142cf6abc0d
1230 return retval; 1230 return retval;
1231 } 1231 }
1232 1232
1233 DEFUN (iscell, args, , 1233 DEFUN (iscell, args, ,
1234 "-*- texinfo -*-\n\ 1234 "-*- texinfo -*-\n\
1235 @deftypefn {Built-in Function} {} iscell (@var{x})\n\ 1235 @deftypefn {} {} iscell (@var{x})\n\
1236 Return true if @var{x} is a cell array object.\n\ 1236 Return true if @var{x} is a cell array object.\n\
1237 @seealso{ismatrix, isstruct, iscellstr, isa}\n\ 1237 @seealso{ismatrix, isstruct, iscellstr, isa}\n\
1238 @end deftypefn") 1238 @end deftypefn")
1239 { 1239 {
1240 if (args.length () != 1) 1240 if (args.length () != 1)
1243 return octave_value (args(0).is_cell ()); 1243 return octave_value (args(0).is_cell ());
1244 } 1244 }
1245 1245
1246 DEFUN (cell, args, , 1246 DEFUN (cell, args, ,
1247 "-*- texinfo -*-\n\ 1247 "-*- texinfo -*-\n\
1248 @deftypefn {Built-in Function} {} cell (@var{n})\n\ 1248 @deftypefn {} {} cell (@var{n})\n\
1249 @deftypefnx {Built-in Function} {} cell (@var{m}, @var{n})\n\ 1249 @deftypefnx {} {} cell (@var{m}, @var{n})\n\
1250 @deftypefnx {Built-in Function} {} cell (@var{m}, @var{n}, @var{k}, @dots{})\n\ 1250 @deftypefnx {} {} cell (@var{m}, @var{n}, @var{k}, @dots{})\n\
1251 @deftypefnx {Built-in Function} {} cell ([@var{m} @var{n} @dots{}])\n\ 1251 @deftypefnx {} {} cell ([@var{m} @var{n} @dots{}])\n\
1252 Create a new cell array object.\n\ 1252 Create a new cell array object.\n\
1253 \n\ 1253 \n\
1254 If invoked with a single scalar integer argument, return a square\n\ 1254 If invoked with a single scalar integer argument, return a square\n\
1255 @nospell{NxN} cell array. If invoked with two or more scalar integer\n\ 1255 @nospell{NxN} cell array. If invoked with two or more scalar integer\n\
1256 arguments, or a vector of integer values, return an array with the given\n\ 1256 arguments, or a vector of integer values, return an array with the given\n\
1294 return retval; 1294 return retval;
1295 } 1295 }
1296 1296
1297 DEFUN (iscellstr, args, , 1297 DEFUN (iscellstr, args, ,
1298 "-*- texinfo -*-\n\ 1298 "-*- texinfo -*-\n\
1299 @deftypefn {Built-in Function} {} iscellstr (@var{cell})\n\ 1299 @deftypefn {} {} iscellstr (@var{cell})\n\
1300 Return true if every element of the cell array @var{cell} is a character\n\ 1300 Return true if every element of the cell array @var{cell} is a character\n\
1301 string.\n\ 1301 string.\n\
1302 @seealso{ischar}\n\ 1302 @seealso{ischar}\n\
1303 @end deftypefn") 1303 @end deftypefn")
1304 { 1304 {
1313 // should keep it in the same file (so we don't have to provide a 1313 // should keep it in the same file (so we don't have to provide a
1314 // declaration) and so we don't have to use feval to call it. 1314 // declaration) and so we don't have to use feval to call it.
1315 1315
1316 DEFUN (cellstr, args, , 1316 DEFUN (cellstr, args, ,
1317 "-*- texinfo -*-\n\ 1317 "-*- texinfo -*-\n\
1318 @deftypefn {Built-in Function} {@var{cstr} =} cellstr (@var{strmat})\n\ 1318 @deftypefn {} {@var{cstr} =} cellstr (@var{strmat})\n\
1319 Create a new cell array object from the elements of the string array\n\ 1319 Create a new cell array object from the elements of the string array\n\
1320 @var{strmat}.\n\ 1320 @var{strmat}.\n\
1321 \n\ 1321 \n\
1322 Each row of @var{strmat} becomes an element of @var{cstr}. Any trailing\n\ 1322 Each row of @var{strmat} becomes an element of @var{cstr}. Any trailing\n\
1323 spaces in a row are deleted before conversion.\n\ 1323 spaces in a row are deleted before conversion.\n\
1347 return retval; 1347 return retval;
1348 } 1348 }
1349 1349
1350 DEFUN (struct2cell, args, , 1350 DEFUN (struct2cell, args, ,
1351 "-*- texinfo -*-\n\ 1351 "-*- texinfo -*-\n\
1352 @deftypefn {Built-in Function} {@var{c} =} struct2cell (@var{s})\n\ 1352 @deftypefn {} {@var{c} =} struct2cell (@var{s})\n\
1353 Create a new cell array from the objects stored in the struct object.\n\ 1353 Create a new cell array from the objects stored in the struct object.\n\
1354 \n\ 1354 \n\
1355 If @var{f} is the number of fields in the structure, the resulting cell\n\ 1355 If @var{f} is the number of fields in the structure, the resulting cell\n\
1356 array will have a dimension vector corresponding to\n\ 1356 array will have a dimension vector corresponding to\n\
1357 @code{[@var{f} size(@var{s})]}. For example:\n\ 1357 @code{[@var{f} size(@var{s})]}. For example:\n\