Mercurial > hg > octave-nkf
diff scripts/plot/close.m @ 17444:ffa7f1caab4e
Clarify relationship of close, closereq.
Recode closereq to put input validation first.
* scripts/plot/close.m: Change docstring to place details of implementation at
the end.
* scripts/plot/closereq.m: Put input validation first.
author | Rik <rik@octave.org> |
---|---|
date | Thu, 19 Sep 2013 12:01:12 -0700 |
parents | bc924baa2c4e |
children |
line wrap: on
line diff
--- a/scripts/plot/close.m +++ b/scripts/plot/close.m @@ -23,10 +23,6 @@ ## @deftypefnx {Command} {} close all hidden ## Close figure window(s). ## -## @code{close} operates by calling the function specified by the -## @qcode{"closerequestfcn"} property for each figure. By default, the function -## @code{closereq} is used. -## ## When called with no arguments, close the current figure. This is equivalent ## to @code{close (gcf)}. If the input @var{h} is a graphic handle, or vector ## of graphics handles, then close each figure in @var{h}. @@ -37,10 +33,12 @@ ## If the argument @qcode{"all hidden"} is given then all figures, including ## hidden ones, are closed. ## -## Implementation Note: @code{close} calls a function to dispose of the figure. -## It is possible that the function will delay or abort removing the figure. -## To remove a figure without executing any callback functions use -## @code{delete}. +## Implementation Note: @code{close} operates by calling the function specified +## by the @qcode{"closerequestfcn"} property for each figure. By default, the +## function @code{closereq} is used. It is possible that the function invoked +## will delay or abort removing the figure. To remove a figure without +## executing any callback functions use @code{delete}. When writing a callback +## function to close a window do not use @code{close} to avoid recursion. ## ## @seealso{closereq, delete} ## @end deftypefn