Mercurial > octave-libgccjit

changeset 18637:2631484789cf

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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 6a4b7ccc60b1
children 4ccd2b473f84
files libinterp/octave-value/ov-class.cc scripts/plot/util/isprop.m
diffstat 2 files changed, 9 insertions(+), 6 deletions(-) [+]
line wrap: on
line diff
--- a/libinterp/octave-value/ov-class.cc	Sun Apr 06 13:38:15 2014 -0700
+++ b/libinterp/octave-value/ov-class.cc	Mon Apr 07 07:46:28 2014 -0700
@@ -2044,7 +2044,7 @@
        "-*- texinfo -*-\n\
 @deftypefn {Built-in Function} {} isobject (@var{x})\n\
 Return true if @var{x} is a class object.\n\
-@seealso{class, typeinfo, isa, ismethod}\n\
+@seealso{class, typeinfo, isa, ismethod, isprop}\n\
 @end deftypefn")
 {
   octave_value retval;
@@ -2059,8 +2059,8 @@
 
 DEFUN (ismethod, args, ,
        "-*- texinfo -*-\n\
-@deftypefn {Built-in Function} {} ismethod (@var{x}, @var{method})\n\
-Return true if @var{x} is a class object and the string @var{method}\n\
+@deftypefn {Built-in Function} {} ismethod (@var{obj}, @var{method})\n\
+Return true if @var{obj} is a class object and the string @var{method}\n\
 is a method of this class.\n\
 @seealso{isprop, isobject}\n\
 @end deftypefn")
--- a/scripts/plot/util/isprop.m	Sun Apr 06 13:38:15 2014 -0700
+++ b/scripts/plot/util/isprop.m	Mon Apr 07 07:46:28 2014 -0700
@@ -17,11 +17,14 @@
 ## <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn {Function File} {@var{res} =} isprop (@var{h}, "@var{prop}")
-## Return true if @var{prop} is a property of the object with handle @var{h}.
+## @deftypefn {Function File} {@var{res} =} isprop (@var{obj}, "@var{prop}")
+## Return true if @var{prop} is a property of the object @var{obj}.
 ##
-## @var{h} may also be an array of handles in which case @var{res} will be a
+## @var{obj} may also be an array of objects in which case @var{res} will be a
 ## logical array indicating whether each handle has the property @var{prop}.
+## 
+## For plotting, @var{obj} is a handle to a graphics object.  Otherwise,
+## @var{obj} should be an instance of a class.
 ## @seealso{get, set, ismethod, isobject}
 ## @end deftypefn