diff src/ov-cell.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 333bf09e3b6e
children 5eb10763069f
line wrap: on
line diff
--- a/src/ov-cell.cc	Fri Dec 31 09:56:44 2010 -0800
+++ b/src/ov-cell.cc	Fri Dec 31 13:20:44 2010 -0800
@@ -1255,8 +1255,8 @@
 DEFUN (iscell, args, ,
   "-*- texinfo -*-\n\
 @deftypefn {Built-in Function} {} iscell (@var{x})\n\
-Return true if @var{x} is a cell array object.  Otherwise, return\n\
-false.\n\
+Return true if @var{x} is a cell array object.\n\
+@seealso{ismatrix, isstruct, iscellstr, isa}\n\
 @end deftypefn")
 {
   octave_value retval;
@@ -1332,7 +1332,8 @@
   "-*- texinfo -*-\n\
 @deftypefn {Built-in Function} {} iscellstr (@var{cell})\n\
 Return true if every element of the cell array @var{cell} is a\n\
-character string\n\
+character string.\n\
+@seealso{ischar}\n\
 @end deftypefn")
 {
   octave_value retval;