Mercurial > octave
diff scripts/plot/util/isaxes.m @ 30558:83aeaba707d8
doc: Use TF for output variable in documentation for isXXX functions in scripts/ directory.
* isplaying.m, isrecording.m, isequal.m, isequaln.m, iscolormap.m,
is_valid_file_id.m, isdir.m, isstr.m, isbanded.m, isdefinite.m, isdiag.m,
ishermitian.m, issymmetric.m, istril.m, istriu.m, isdeployed.m, isfolder.m,
ismac.m, ismethod.m, ispc.m, isunix.m, isaxes.m, isfigure.m, isgraphics.m,
ishandle.m, ishold.m, ispref.m, isprime.m, isletter.m, isstring.m, isstrprop.m,
is_leap_year.m:
Use TF for output variable in documentation for isXXX functions.
Change variable name in code function prototype to match documentation.
| author | Rik <rik@octave.org> |
|---|---|
| date | Mon, 27 Dec 2021 16:07:08 -0800 |
| parents | 7854d5752dd2 |
| children | 83f9f8bda883 |
line wrap: on
line diff
--- a/scripts/plot/util/isaxes.m Mon Dec 27 15:51:12 2021 -0800 +++ b/scripts/plot/util/isaxes.m Mon Dec 27 16:07:08 2021 -0800 @@ -24,7 +24,7 @@ ######################################################################## ## -*- texinfo -*- -## @deftypefn {} {} isaxes (@var{h}) +## @deftypefn {} {@var{tf} =} isaxes (@var{h}) ## Return true if @var{h} is an axes graphics handle and false otherwise. ## ## If @var{h} is a matrix then return a logical array which is true where the @@ -32,16 +32,16 @@ ## @seealso{isfigure, ishghandle, isgraphics} ## @end deftypefn -function retval = isaxes (h) +function tf = isaxes (h) if (nargin < 1) print_usage (); endif - retval = ishghandle (h); + tf = ishghandle (h); - if (any (retval)) - retval(retval) = strcmp (get (h(retval), "type"), "axes"); + if (any (tf)) + tf(tf) = strcmp (get (h(tf), "type"), "axes"); endif endfunction