Mercurial > hg > octave-lyh

comparison scripts/plot/close.m @ 17126:eaab03308c0b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Rewrite docstrings for most plot functions. Emphasize clarity, use common "voice", and increase density of seealso links. * doc/interpreter/plot.txi: Add @findex entries that were in xlim.m * scripts/miscellaneous/getappdata.m scripts/miscellaneous/setappdata.m, scripts/plot/allchild.m, scripts/plot/ancestor.m, scripts/plot/area.m, scripts/plot/axes.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/closereq.m, scripts/plot/colorbar.m, scripts/plot/comet.m, scripts/plot/comet3.m, scripts/plot/compass.m, scripts/plot/contour.m, scripts/plot/contour3.m, scripts/plot/contourc.m, scripts/plot/contourf.m, scripts/plot/copyobj.m, scripts/plot/cylinder.m, scripts/plot/daspect.m, scripts/plot/diffuse.m, scripts/plot/ellipsoid.m, scripts/plot/errorbar.m, scripts/plot/ezcontour.m, scripts/plot/ezcontourf.m, scripts/plot/ezmesh.m, scripts/plot/ezmeshc.m, scripts/plot/ezplot.m, scripts/plot/ezplot3.m, scripts/plot/ezpolar.m, scripts/plot/ezsurf.m, scripts/plot/ezsurfc.m, scripts/plot/feather.m, scripts/plot/figure.m, scripts/plot/fill.m, scripts/plot/findall.m, scripts/plot/findobj.m, scripts/plot/fplot.m, scripts/plot/gca.m, scripts/plot/gcbf.m, scripts/plot/gcbo.m, scripts/plot/gcf.m, scripts/plot/gco.m, scripts/plot/ginput.m, scripts/plot/graphics_toolkit.m, scripts/plot/grid.m, scripts/plot/gtext.m, scripts/plot/guidata.m, scripts/plot/guihandles.m, scripts/plot/hdl2struct.m, scripts/plot/hggroup.m, scripts/plot/hidden.m, scripts/plot/hist.m, scripts/plot/hold.m, scripts/plot/ishghandle.m, scripts/plot/ishold.m, scripts/plot/isocolors.m, scripts/plot/isprop.m, scripts/plot/legend.m, scripts/plot/line.m, scripts/plot/linkprop.m, scripts/plot/loglog.m, scripts/plot/loglogerr.m, scripts/plot/mesh.m, scripts/plot/meshc.m, scripts/plot/meshgrid.m, scripts/plot/meshz.m, scripts/plot/newplot.m, scripts/plot/orient.m, scripts/plot/pareto.m, scripts/plot/patch.m, scripts/plot/pcolor.m, scripts/plot/peaks.m, scripts/plot/pie.m, scripts/plot/pie3.m, scripts/plot/plot.m, scripts/plot/plot3.m, scripts/plot/plotmatrix.m, scripts/plot/plotyy.m, scripts/plot/polar.m, scripts/plot/print.m, scripts/plot/quiver.m, scripts/plot/quiver3.m, scripts/plot/rectangle.m, scripts/plot/refresh.m, scripts/plot/refreshdata.m, scripts/plot/ribbon.m, scripts/plot/rose.m, scripts/plot/saveas.m, scripts/plot/scatter.m, scripts/plot/scatter3.m, scripts/plot/semilogx.m, scripts/plot/semilogxerr.m, scripts/plot/semilogy.m, scripts/plot/semilogyerr.m, scripts/plot/shading.m, scripts/plot/shg.m, scripts/plot/shrinkfaces.m, scripts/plot/slice.m, scripts/plot/specular.m, scripts/plot/sphere.m, scripts/plot/stairs.m, scripts/plot/stem.m, scripts/plot/stem3.m, scripts/plot/struct2hdl.m, scripts/plot/subplot.m, scripts/plot/surf.m, scripts/plot/surface.m, scripts/plot/surfc.m, scripts/plot/surfl.m, scripts/plot/tetramesh.m, scripts/plot/text.m, scripts/plot/title.m, scripts/plot/trimesh.m, scripts/plot/triplot.m, scripts/plot/trisurf.m, scripts/plot/view.m, scripts/plot/waitbar.m, scripts/plot/waitforbuttonpress.m, scripts/plot/waterfall.m, scripts/plot/whitebg.m, scripts/plot/xlabel.m, scripts/plot/xlim.m, scripts/plot/ylabel.m, scripts/plot/ylim.m, scripts/plot/zlabel.m, scripts/plot/zlim.m: Rewrite docstrings for most plot functions. Emphasize clarity, use common "voice", and increase density of seealso links.
author Rik <rik@octave.org>
date Wed, 31 Jul 2013 13:53:30 -0700
parents e5ded64def41
children 723a08d266d2
comparison
equal deleted inserted replaced
17125:d4549655b92e 17126:eaab03308c0b
22 ## @deftypefnx {Command} {} close all 22 ## @deftypefnx {Command} {} close all
23 ## @deftypefnx {Command} {} close all hidden 23 ## @deftypefnx {Command} {} close all hidden
24 ## Close figure window(s). 24 ## Close figure window(s).
25 ## 25 ##
26 ## @code{close} operates by calling the function specified by the 26 ## @code{close} operates by calling the function specified by the
27 ## @code{"closerequestfcn"} property for each figure. By default, the function 27 ## "closerequestfcn" property for each figure. By default, the function
28 ## @code{closereq} is used. 28 ## @code{closereq} is used.
29 ## 29 ##
30 ## When called with no arguments, close the current figure. This is equivalent 30 ## When called with no arguments, close the current figure. This is equivalent
31 ## to @code{close (gcf)}. If the input is a graphic handle @var{h} or vector 31 ## to @code{close (gcf)}. If the input @var{h} is a graphic handle, or vector
32 ## of graphics handles then close each figure in @var{h}. 32 ## of graphics handles, then close each figure in @var{h}.
33 ## 33 ##
34 ## If the argument "all" is given then all figures with visible handles 34 ## If the argument "all" is given then all figures with visible handles
35 ## (HandleVisibility = "on") are closed. 35 ## (HandleVisibility = "on") are closed.
36 ## 36 ##
37 ## If the argument "all hidden" is given then all figures, including hidden 37 ## If the argument "all hidden" is given then all figures, including hidden
38 ## ones, are closed. 38 ## ones, are closed.
39 ## 39 ##
40 ## Implementation Note: @code{close} calls a function to dispose of the figure. 40 ## Implementation Note: @code{close} calls a function to dispose of the figure.
41 ## It is possible that the function will delay or abort removing the figure. 41 ## It is possible that the function will delay or abort removing the figure.
42 ## To remove a figure without calling any callback functions use @code{delete}. 42 ## To remove a figure without executing any callback functions use
43 ## @code{delete}.
43 ## 44 ##
44 ## @seealso{closereq, delete} 45 ## @seealso{closereq, delete}
45 ## @end deftypefn 46 ## @end deftypefn
46 47
47 ## Author: jwe 48 ## Author: jwe