diff src/strfns.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 a4f482e66b65
children fd0a3ac60b0e
line wrap: on
line diff
--- a/src/strfns.cc	Fri Dec 31 09:56:44 2010 -0800
+++ b/src/strfns.cc	Fri Dec 31 13:20:44 2010 -0800
@@ -297,8 +297,9 @@
 
 DEFUN (ischar, args, ,
   "-*- texinfo -*-\n\
-@deftypefn {Built-in Function} {} ischar (@var{a})\n\
-Return 1 if @var{a} is a character array.  Otherwise, return 0.\n\
+@deftypefn {Built-in Function} {} ischar (@var{x})\n\
+Return true if @var{x} is a character array.\n\
+@seealso{isfloat, isinteger, islogical, isnumeric, iscellstr, isa}\n\
 @end deftypefn")
 {
   octave_value retval;