comparison libinterp/octave-value/ov-class.cc @ 18637:2631484789cf

doc: Improve docstrings for isobject, ismethod, isprop. * ov-class.cc (Fisobject): Add seealso link to isprop. * ov-class.cc (Fismethod): Use 'obj' as the input variable name, rather than just 'x'. * isprop.m: Use 'obj' as the input variable name, rather than just 'h'. Add note that 'obj' may be a class object or a handle to a graphics object.
author Rik <rik@octave.org>
date Mon, 07 Apr 2014 07:46:28 -0700
parents f958e8cd6348
children 6113e0c6920b
comparison
equal deleted inserted replaced
18635:6a4b7ccc60b1 18637:2631484789cf
2042 2042
2043 DEFUN (isobject, args, , 2043 DEFUN (isobject, args, ,
2044 "-*- texinfo -*-\n\ 2044 "-*- texinfo -*-\n\
2045 @deftypefn {Built-in Function} {} isobject (@var{x})\n\ 2045 @deftypefn {Built-in Function} {} isobject (@var{x})\n\
2046 Return true if @var{x} is a class object.\n\ 2046 Return true if @var{x} is a class object.\n\
2047 @seealso{class, typeinfo, isa, ismethod}\n\ 2047 @seealso{class, typeinfo, isa, ismethod, isprop}\n\
2048 @end deftypefn") 2048 @end deftypefn")
2049 { 2049 {
2050 octave_value retval; 2050 octave_value retval;
2051 2051
2052 if (args.length () == 1) 2052 if (args.length () == 1)
2057 return retval; 2057 return retval;
2058 } 2058 }
2059 2059
2060 DEFUN (ismethod, args, , 2060 DEFUN (ismethod, args, ,
2061 "-*- texinfo -*-\n\ 2061 "-*- texinfo -*-\n\
2062 @deftypefn {Built-in Function} {} ismethod (@var{x}, @var{method})\n\ 2062 @deftypefn {Built-in Function} {} ismethod (@var{obj}, @var{method})\n\
2063 Return true if @var{x} is a class object and the string @var{method}\n\ 2063 Return true if @var{obj} is a class object and the string @var{method}\n\
2064 is a method of this class.\n\ 2064 is a method of this class.\n\
2065 @seealso{isprop, isobject}\n\ 2065 @seealso{isprop, isobject}\n\
2066 @end deftypefn") 2066 @end deftypefn")
2067 { 2067 {
2068 octave_value retval; 2068 octave_value retval;