Mercurial > octave
diff scripts/plot/util/ishold.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/ishold.m Mon Dec 27 15:51:12 2021 -0800 +++ b/scripts/plot/util/ishold.m Mon Dec 27 16:07:08 2021 -0800 @@ -24,9 +24,9 @@ ######################################################################## ## -*- texinfo -*- -## @deftypefn {} {} ishold -## @deftypefnx {} {} ishold (@var{hax}) -## @deftypefnx {} {} ishold (@var{hfig}) +## @deftypefn {} {@var{tf} =} ishold +## @deftypefnx {} {@var{tf} =} ishold (@var{hax}) +## @deftypefnx {} {@var{tf} =} ishold (@var{hfig}) ## Return true if the next plot will be added to the current plot, or ## false if the plot device will be cleared before drawing the next plot. ## @@ -35,7 +35,7 @@ ## @seealso{hold, newplot} ## @end deftypefn -function retval = ishold (h) +function tf = ishold (h) if (nargin == 0) fig = gcf (); @@ -60,7 +60,7 @@ endswitch endif - retval = (strcmp (get (fig, "nextplot"), "add") + tf = (strcmp (get (fig, "nextplot"), "add") && ! isempty (ax) && strcmp (get (ax, "nextplot"), "add")); endfunction