annotate scripts/plot/clf.m @ 17281:bc924baa2c4e

doc: Add new @qcode macro for code samples which are quoted. Macro handles options ("on") or properties ("position") more elegantly than @code{"text"}. * doc/interpreter/macros.texi: Add new @qcode macro. * doc/interpreter/tips.txi: Add documentation about @qcode macro. * doc/interpreter/basics.txi, doc/interpreter/container.txi, doc/interpreter/emacs.txi, doc/interpreter/errors.txi, doc/interpreter/eval.txi, doc/interpreter/expr.txi, doc/interpreter/external.txi, doc/interpreter/func.txi, doc/interpreter/grammar.txi, doc/interpreter/image.txi, doc/interpreter/install.txi, doc/interpreter/interp.txi, doc/interpreter/io.txi, doc/interpreter/matrix.txi, doc/interpreter/numbers.txi, doc/interpreter/oop.txi, doc/interpreter/package.txi, doc/interpreter/plot.txi, doc/interpreter/quad.txi, doc/interpreter/sparse.txi, doc/interpreter/strings.txi, doc/interpreter/system.txi, doc/interpreter/vectorize.txi, libinterp/corefcn/balance.cc, libinterp/corefcn/bitfcns.cc, libinterp/corefcn/cellfun.cc, libinterp/corefcn/conv2.cc, libinterp/corefcn/data.cc, libinterp/corefcn/debug.cc, libinterp/corefcn/defaults.cc, libinterp/corefcn/dirfns.cc, libinterp/corefcn/dlmread.cc, libinterp/corefcn/error.cc, libinterp/corefcn/file-io.cc, libinterp/corefcn/find.cc, libinterp/corefcn/gammainc.cc, libinterp/corefcn/graphics.cc, libinterp/corefcn/help.cc, libinterp/corefcn/hex2num.cc, libinterp/corefcn/input.cc, libinterp/corefcn/load-path.cc, libinterp/corefcn/load-save.cc, libinterp/corefcn/ls-oct-ascii.cc, libinterp/corefcn/lu.cc, libinterp/corefcn/luinc.cc, libinterp/corefcn/matrix_type.cc, libinterp/corefcn/oct-hist.cc, libinterp/corefcn/pager.cc, libinterp/corefcn/pr-output.cc, libinterp/corefcn/pt-jit.cc, libinterp/corefcn/qz.cc, libinterp/corefcn/rand.cc, libinterp/corefcn/regexp.cc, libinterp/corefcn/schur.cc, libinterp/corefcn/sighandlers.cc, libinterp/corefcn/sparse.cc, libinterp/corefcn/spparms.cc, libinterp/corefcn/str2double.cc, libinterp/corefcn/svd.cc, libinterp/corefcn/symtab.cc, libinterp/corefcn/syscalls.cc, libinterp/corefcn/toplev.cc, libinterp/corefcn/tril.cc, libinterp/corefcn/typecast.cc, libinterp/corefcn/utils.cc, libinterp/corefcn/variables.cc, libinterp/dldfcn/__init_fltk__.cc, libinterp/dldfcn/chol.cc, libinterp/dldfcn/colamd.cc, libinterp/dldfcn/fftw.cc, libinterp/dldfcn/qr.cc, libinterp/dldfcn/symbfact.cc, libinterp/octave-value/ov-base.cc, libinterp/octave-value/ov-fcn-handle.cc, libinterp/octave-value/ov-fcn-inline.cc, libinterp/octave-value/ov-java.cc, libinterp/octave-value/ov-range.cc, libinterp/octave-value/ov-struct.cc, libinterp/octave-value/ov-usr-fcn.cc, libinterp/parse-tree/oct-parse.in.yy, libinterp/parse-tree/pt-binop.cc, libinterp/parse-tree/pt-eval.cc, libinterp/parse-tree/pt-mat.cc, scripts/@ftp/ftp.m, scripts/deprecated/java_convert_matrix.m, scripts/deprecated/java_debug.m, scripts/deprecated/java_unsigned_conversion.m, scripts/deprecated/shell_cmd.m, scripts/general/dblquad.m, scripts/general/display.m, scripts/general/genvarname.m, scripts/general/idivide.m, scripts/general/interp1.m, scripts/general/interp2.m, scripts/general/interp3.m, scripts/general/interpn.m, scripts/general/isa.m, scripts/general/profexplore.m, scripts/general/profile.m, scripts/general/quadgk.m, scripts/general/randi.m, scripts/general/structfun.m, scripts/general/subsindex.m, scripts/general/triplequad.m, scripts/geometry/griddata.m, scripts/geometry/griddata3.m, scripts/geometry/griddatan.m, scripts/geometry/voronoi.m, scripts/help/help.m, scripts/help/lookfor.m, scripts/image/cmpermute.m, scripts/image/colormap.m, scripts/image/image.m, scripts/image/imagesc.m, scripts/image/imfinfo.m, scripts/image/imformats.m, scripts/image/imread.m, scripts/image/imshow.m, scripts/image/imwrite.m, scripts/image/ind2gray.m, scripts/image/lines.m, scripts/image/rgb2ind.m, scripts/image/spinmap.m, scripts/io/dlmwrite.m, scripts/io/strread.m, scripts/io/textread.m, scripts/io/textscan.m, scripts/java/javaclasspath.m, scripts/java/usejava.m, scripts/miscellaneous/bzip2.m, scripts/miscellaneous/computer.m, scripts/miscellaneous/copyfile.m, scripts/miscellaneous/debug.m, scripts/miscellaneous/dos.m, scripts/miscellaneous/edit.m, scripts/miscellaneous/gzip.m, scripts/miscellaneous/license.m, scripts/miscellaneous/mkoctfile.m, scripts/miscellaneous/movefile.m, scripts/miscellaneous/parseparams.m, scripts/miscellaneous/unix.m, scripts/optimization/fminbnd.m, scripts/optimization/fminsearch.m, scripts/optimization/fminunc.m, scripts/optimization/fsolve.m, scripts/optimization/fzero.m, scripts/optimization/glpk.m, scripts/optimization/lsqnonneg.m, scripts/optimization/optimset.m, scripts/optimization/pqpnonneg.m, scripts/pkg/pkg.m, scripts/plot/allchild.m, scripts/plot/ancestor.m, scripts/plot/area.m, scripts/plot/axis.m, scripts/plot/bar.m, scripts/plot/barh.m, scripts/plot/box.m, scripts/plot/caxis.m, scripts/plot/cla.m, scripts/plot/clabel.m, scripts/plot/clf.m, scripts/plot/close.m, scripts/plot/colorbar.m, scripts/plot/daspect.m, scripts/plot/ezmesh.m, scripts/plot/ezmeshc.m, scripts/plot/ezsurf.m, scripts/plot/ezsurfc.m, scripts/plot/findall.m, scripts/plot/findobj.m, scripts/plot/gcbo.m, scripts/plot/gcf.m, scripts/plot/gco.m, scripts/plot/grid.m, scripts/plot/guihandles.m, scripts/plot/hdl2struct.m, scripts/plot/hidden.m, scripts/plot/hold.m, scripts/plot/isonormals.m, scripts/plot/isosurface.m, scripts/plot/legend.m, scripts/plot/mesh.m, scripts/plot/meshc.m, scripts/plot/meshz.m, scripts/plot/newplot.m, scripts/plot/orient.m, scripts/plot/pareto.m, scripts/plot/patch.m, scripts/plot/pbaspect.m, scripts/plot/pcolor.m, scripts/plot/plot.m, scripts/plot/print.m, scripts/plot/private/__add_default_menu__.m, scripts/plot/quiver.m, scripts/plot/quiver3.m, scripts/plot/refreshdata.m, scripts/plot/saveas.m, scripts/plot/scatter.m, scripts/plot/scatter3.m, scripts/plot/shading.m, scripts/plot/shrinkfaces.m, scripts/plot/slice.m, scripts/plot/stem.m, scripts/plot/stem3.m, scripts/plot/struct2hdl.m, scripts/plot/subplot.m, scripts/plot/surf.m, scripts/plot/surfc.m, scripts/plot/surfl.m, scripts/plot/tetramesh.m, scripts/plot/uigetfile.m, scripts/plot/uimenu.m, scripts/plot/uiputfile.m, scripts/plot/waterfall.m, scripts/plot/whitebg.m, scripts/plot/xlim.m, scripts/plot/ylim.m, scripts/plot/zlim.m, scripts/polynomial/conv.m, scripts/polynomial/polyout.m, scripts/polynomial/splinefit.m, scripts/set/ismember.m, scripts/set/powerset.m, scripts/set/setdiff.m, scripts/set/union.m, scripts/set/unique.m, scripts/signal/detrend.m, scripts/signal/filter2.m, scripts/signal/freqz.m, scripts/signal/periodogram.m, scripts/signal/spectral_adf.m, scripts/signal/spectral_xdf.m, scripts/sparse/eigs.m, scripts/sparse/svds.m, scripts/specfun/legendre.m, scripts/special-matrix/gallery.m, scripts/statistics/base/mean.m, scripts/statistics/base/moment.m, scripts/statistics/tests/cor_test.m, scripts/statistics/tests/kolmogorov_smirnov_test.m, scripts/statistics/tests/kolmogorov_smirnov_test_2.m, scripts/statistics/tests/kruskal_wallis_test.m, scripts/statistics/tests/prop_test_2.m, scripts/statistics/tests/sign_test.m, scripts/statistics/tests/t_test.m, scripts/statistics/tests/t_test_2.m, scripts/statistics/tests/t_test_regression.m, scripts/statistics/tests/u_test.m, scripts/statistics/tests/var_test.m, scripts/statistics/tests/welch_test.m, scripts/statistics/tests/wilcoxon_test.m, scripts/statistics/tests/z_test.m, scripts/statistics/tests/z_test_2.m, scripts/strings/base2dec.m, scripts/strings/index.m, scripts/strings/isstrprop.m, scripts/strings/mat2str.m, scripts/strings/regexptranslate.m, scripts/strings/rindex.m, scripts/strings/str2num.m, scripts/strings/strcat.m, scripts/strings/strjust.m, scripts/strings/strmatch.m, scripts/strings/validatestring.m, scripts/testfun/demo.m, scripts/testfun/example.m, scripts/testfun/test.m, scripts/time/addtodate.m, scripts/time/asctime.m, scripts/time/datestr.m, scripts/time/datetick.m, scripts/time/weekday.m, scripts/ui/errordlg.m, scripts/ui/helpdlg.m, scripts/ui/inputdlg.m, scripts/ui/listdlg.m, scripts/ui/msgbox.m, scripts/ui/questdlg.m, scripts/ui/warndlg.m: Use new @qcode macro.
author Rik <rik@octave.org>
date Mon, 19 Aug 2013 20:46:38 -0700
parents eaab03308c0b
children 0aa77acf22f5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14138
72c96de7a403 maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents: 14001
diff changeset
1 ## Copyright (C) 2005-2012 John W. Eaton
5597
e0e48ea2a93c [project @ 2006-01-13 21:17:37 by jwe]
jwe
parents:
diff changeset
2 ##
e0e48ea2a93c [project @ 2006-01-13 21:17:37 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
e0e48ea2a93c [project @ 2006-01-13 21:17:37 by jwe]
jwe
parents:
diff changeset
4 ##
e0e48ea2a93c [project @ 2006-01-13 21:17:37 by jwe]
jwe
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
e0e48ea2a93c [project @ 2006-01-13 21:17:37 by jwe]
jwe
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6895
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6895
diff changeset
8 ## your option) any later version.
5597
e0e48ea2a93c [project @ 2006-01-13 21:17:37 by jwe]
jwe
parents:
diff changeset
9 ##
e0e48ea2a93c [project @ 2006-01-13 21:17:37 by jwe]
jwe
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
e0e48ea2a93c [project @ 2006-01-13 21:17:37 by jwe]
jwe
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
e0e48ea2a93c [project @ 2006-01-13 21:17:37 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
e0e48ea2a93c [project @ 2006-01-13 21:17:37 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
e0e48ea2a93c [project @ 2006-01-13 21:17:37 by jwe]
jwe
parents:
diff changeset
14 ##
e0e48ea2a93c [project @ 2006-01-13 21:17:37 by jwe]
jwe
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6895
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6895
diff changeset
17 ## <http://www.gnu.org/licenses/>.
5597
e0e48ea2a93c [project @ 2006-01-13 21:17:37 by jwe]
jwe
parents:
diff changeset
18
e0e48ea2a93c [project @ 2006-01-13 21:17:37 by jwe]
jwe
parents:
diff changeset
19 ## -*- texinfo -*-
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17092
diff changeset
20 ## @deftypefn {Command} {} clf
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17092
diff changeset
21 ## @deftypefnx {Command} {} clf reset
8250
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
22 ## @deftypefnx {Function File} {} clf (@var{hfig})
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
23 ## @deftypefnx {Function File} {} clf (@var{hfig}, "reset")
13316
959944e9d927 fix clf docstring typo from previous change
John W. Eaton <jwe@octave.org>
parents: 13313
diff changeset
24 ## @deftypefnx {Function File} {@var{h} =} clf (@dots{})
17092
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
25 ## Clear the current figure window.
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
26 ##
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
27 ## @code{clf} operates by deleting child graphics objects with visible
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17122
diff changeset
28 ## handles (HandleVisibility = @qcode{"on"}).
17092
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
29 ##
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17122
diff changeset
30 ## If the optional argument @qcode{"reset"} is specified, delete all child
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17122
diff changeset
31 ## objects including those with hidden handles and reset all figure
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17122
diff changeset
32 ## properties to their defaults. However, the following properties are not
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17122
diff changeset
33 ## reset: Position, Units, PaperPosition, PaperUnits.
17092
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
34 ##
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
35 ## If the first argument @var{hfig} is a figure handle, then operate on
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
36 ## this figure rather than the current figure returned by @code{gcf}.
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 13316
diff changeset
37 ##
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 13316
diff changeset
38 ## The optional return value @var{h} is the graphics handle of the figure
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 13316
diff changeset
39 ## window that was cleared.
8250
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
40 ## @seealso{cla, close, delete}
5597
e0e48ea2a93c [project @ 2006-01-13 21:17:37 by jwe]
jwe
parents:
diff changeset
41 ## @end deftypefn
e0e48ea2a93c [project @ 2006-01-13 21:17:37 by jwe]
jwe
parents:
diff changeset
42
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6030
diff changeset
43 ## Author: jwe
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6030
diff changeset
44
17092
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
45 function h = clf (varargin)
5597
e0e48ea2a93c [project @ 2006-01-13 21:17:37 by jwe]
jwe
parents:
diff changeset
46
8250
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
47 if (nargin > 2)
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
48 print_usage ();
17092
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
49 elseif (nargin == 0)
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
50 hfig = gcf;
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
51 do_reset = false;
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
52 elseif (nargin == 1)
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
53 if (isscalar (varargin{1}) && isfigure (varargin{1}))
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
54 hfig = varargin{1};
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
55 do_reset = false;
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
56 elseif (ischar (varargin{1}) && strcmpi (varargin{1}, "reset"))
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
57 hfig = gcf;
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
58 do_reset = true;
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
59 else
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
60 print_usage ();
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
61 endif
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
62 else
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
63 if (isscalar (varargin{1}) && isfigure (varargin{1})
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
64 && ischar (varargin{2}) && strcmpi (varargin{2}, "reset"))
8250
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
65 hfig = varargin{1};
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
66 do_reset = true;
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
67 else
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
68 print_usage ();
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
69 endif
8610
85c9906abfd1 use endif and endfor instead of end
John W. Eaton <jwe@octave.org>
parents: 8250
diff changeset
70 endif
8250
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
71
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
72 if (do_reset)
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
73 ## Select all the children, including the one with hidden handles.
17092
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
74 delete (allchild (hfig));
11589
b0084095098e missing semicolons in script files
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
75 reset (hfig);
8250
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
76 else
8a2559a1aefa clf.m: Improve Matlab compatibility.
Ben Abbott <bpabbott@mac.com>
parents: 7017
diff changeset
77 ## Select only the chilren with visible handles.
17092
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
78 delete (get (hfig, "children"));
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6030
diff changeset
79 endif
5597
e0e48ea2a93c [project @ 2006-01-13 21:17:37 by jwe]
jwe
parents:
diff changeset
80
13313
467276f9a366 clf: return figure handle
John W. Eaton <jwe@octave.org>
parents: 13141
diff changeset
81 if (nargout > 0)
17092
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
82 h = hfig;
13313
467276f9a366 clf: return figure handle
John W. Eaton <jwe@octave.org>
parents: 13141
diff changeset
83 endif
467276f9a366 clf: return figure handle
John W. Eaton <jwe@octave.org>
parents: 13141
diff changeset
84
5597
e0e48ea2a93c [project @ 2006-01-13 21:17:37 by jwe]
jwe
parents:
diff changeset
85 endfunction
13096
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11589
diff changeset
86
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 13316
diff changeset
87
13096
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11589
diff changeset
88 %!test
13124
2ea1658ad049 Don't use explicit figure number for tests to avoid interference with any figures opened by user.
Kai Habel <kai.habel@gmx.de>
parents: 13111
diff changeset
89 %! hf = figure ("visible", "off");
13141
e81ddf9cacd5 maint: untabify and remove trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 13124
diff changeset
90 %! unwind_protect
13096
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11589
diff changeset
91 %! l = line;
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
92 %! assert (! isempty (get (gcf, "children")));
17092
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
93 %! clf;
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
94 %! assert (isempty (get (gcf, "children")));
13111
ebb42fb2da04 Various fixes for tests in scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 13096
diff changeset
95 %! unwind_protect_cleanup
ebb42fb2da04 Various fixes for tests in scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 13096
diff changeset
96 %! close (hf);
ebb42fb2da04 Various fixes for tests in scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 13096
diff changeset
97 %! end_unwind_protect
ebb42fb2da04 Various fixes for tests in scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 13096
diff changeset
98
ebb42fb2da04 Various fixes for tests in scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 13096
diff changeset
99 %!test
13124
2ea1658ad049 Don't use explicit figure number for tests to avoid interference with any figures opened by user.
Kai Habel <kai.habel@gmx.de>
parents: 13111
diff changeset
100 %! hf = figure ("visible", "off");
13141
e81ddf9cacd5 maint: untabify and remove trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 13124
diff changeset
101 %! unwind_protect
13096
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11589
diff changeset
102 %! clf;
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11589
diff changeset
103 %! assert (isempty (get (gcf, "children")));
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11589
diff changeset
104 %! unwind_protect_cleanup
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11589
diff changeset
105 %! close (hf);
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11589
diff changeset
106 %! end_unwind_protect
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 13316
diff changeset
107
17092
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
108 %!xtest
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
109 %! hf = figure ("visible", "off");
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
110 %! unwind_protect
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
111 %! plot (1:10);
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
112 %! set (hf, "papertype", "tabloid");
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
113 %! clf (hf);
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
114 %! assert (isempty (get (gcf, "children")));
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
115 %! assert (get (hf, "papertype"), "tabloid");
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
116 %! plot (1:10);
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
117 %! clf (hf, "reset");
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
118 %! kids = get (hf, "children");
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
119 %! assert (isempty (get (gcf, "children")));
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
120 %! assert (get (hf, "papertype"), "usletter");
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
121 %! unwind_protect_cleanup
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
122 %! close (hf);
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
123 %! end_unwind_protect
498b9f62199a clf.m: Update docstring and simplify code. Add new %!demo block.
Rik <rik@octave.org>
parents: 14363
diff changeset
124