Mercurial > hg > octave-nkf
diff src/ov-struct.cc @ 11431:0d9640d755b1
Improve docstrings for all isXXX functions.
Use 'return true' rather than 'return 1'.
Improve the cross-referencing through seealso links.
| author | Rik <octave@nomad.inbox5.com> |
|---|---|
| date | Fri, 31 Dec 2010 13:20:44 -0800 |
| parents | e4ba3cb2d27e |
| children | 8a40037533e2 |
line wrap: on
line diff
--- a/src/ov-struct.cc +++ b/src/ov-struct.cc @@ -1885,9 +1885,9 @@ DEFUN (isstruct, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} isstruct (@var{expr})\n\ -Return 1 if the value of the expression @var{expr} is a structure\n\ -(or a structure array).\n\ +@deftypefn {Built-in Function} {} isstruct (@var{x})\n\ +Return true if @var{x} is a structure or a structure array.\n\ +@seealso{ismatrix, iscell, isa}\n\ @end deftypefn") { octave_value retval; @@ -1945,10 +1945,10 @@ DEFUN (isfield, args, , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {} isfield (@var{expr}, @var{name})\n\ -Return true if the expression @var{expr} is a structure and it\n\ +@deftypefn {Built-in Function} {} isfield (@var{x}, @var{name})\n\ +Return true if the @var{x} is a structure and it\n\ includes an element named @var{name}. If @var{name} is a cell\n\ -array, a logical array of equal dimension is returned.\n\ +array of strings then a logical array of equal dimension is returned.\n\ @end deftypefn") { octave_value retval;