Mercurial > hg > octave-nkf

diff src/variables.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: 0c38b45ab49c
children: fd0a3ac60b0e
--- a/src/variables.cc
+++ b/src/variables.cc
@@ -355,8 +355,8 @@
 DEFUN (isglobal, args, ,
   "-*- texinfo -*-\n\
 @deftypefn {Built-in Function} {} isglobal (@var{name})\n\
-Return 1 if @var{name} is globally visible.  Otherwise, return 0.  For\n\
-example,\n\
+Return true if @var{name} is a globally visible variable.\n\
+For example:\n\
 \n\
 @example\n\
 @group\n\
@@ -365,6 +365,7 @@
      @result{} 1\n\
 @end group\n\
 @end example\n\
+@seealso{isvarname, exist}\n\
 @end deftypefn")
 {
   return do_isglobal (args);