octave-nkf: scripts/plot/closereq.m annotate

annotate scripts/plot/closereq.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	1c89599167a6
children

rev	line source
14138 72c96de7a403 maint: update copyright notices for 2012 John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	1 ## Copyright (C) 2005-2012 John W. Eaton
6257 44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: diff changeset	2 ##
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: diff changeset	3 ## This file is part of Octave.
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: diff changeset	4 ##
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: diff changeset	5 ## Octave is free software; you can redistribute it and/or modify it
44c91c5dfe1d [project @ 2007-01-30 19:16:52 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.
6257 44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: diff changeset	9 ##
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: diff changeset	10 ## Octave is distributed in the hope that it will be useful, but
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: diff changeset	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: diff changeset	13 ## General Public License for more details.
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: diff changeset	14 ##
44c91c5dfe1d [project @ 2007-01-30 19:16:52 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/>.
6257 44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: diff changeset	18
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: diff changeset	19 ## -- texinfo --
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: diff changeset	20 ## @deftypefn {Function File} {} closereq ()
17122 eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 15466 diff changeset	21 ## Close the current figure and delete all graphics objects associated with it.
17444 ffa7f1caab4e Clarify relationship of close, closereq. Rik <rik@octave.org> parents: 17338 diff changeset	22 ##
ffa7f1caab4e Clarify relationship of close, closereq. Rik <rik@octave.org> parents: 17338 diff changeset	23 ## By default, the @qcode{"closerequestfcn"} property of a new plot figure
ffa7f1caab4e Clarify relationship of close, closereq. Rik <rik@octave.org> parents: 17338 diff changeset	24 ## points to this function.
6895 76e3d985ae56 [project @ 2007-09-13 18:22:38 by jwe] jwe parents: 6405 diff changeset	25 ## @seealso{close, delete}
6257 44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: diff changeset	26 ## @end deftypefn
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: diff changeset	27
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: diff changeset	28 ## Author: jwe
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: diff changeset	29
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: diff changeset	30 function closereq ()
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: diff changeset	31
17444 ffa7f1caab4e Clarify relationship of close, closereq. Rik <rik@octave.org> parents: 17338 diff changeset	32 if (nargin != 0)
6257 44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: diff changeset	33 print_usage ();
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: diff changeset	34 endif
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: diff changeset	35
17444 ffa7f1caab4e Clarify relationship of close, closereq. Rik <rik@octave.org> parents: 17338 diff changeset	36 cf = gcbf ();
ffa7f1caab4e Clarify relationship of close, closereq. Rik <rik@octave.org> parents: 17338 diff changeset	37 if (isempty (cf))
ffa7f1caab4e Clarify relationship of close, closereq. Rik <rik@octave.org> parents: 17338 diff changeset	38 warning ("closereq: calling closereq from octave prompt is not supported, use 'close' instead");
ffa7f1caab4e Clarify relationship of close, closereq. Rik <rik@octave.org> parents: 17338 diff changeset	39 cf = get (0, "currentfigure");
ffa7f1caab4e Clarify relationship of close, closereq. Rik <rik@octave.org> parents: 17338 diff changeset	40 endif
ffa7f1caab4e Clarify relationship of close, closereq. Rik <rik@octave.org> parents: 17338 diff changeset	41 if (! isempty (cf) && isfigure (cf))
ffa7f1caab4e Clarify relationship of close, closereq. Rik <rik@octave.org> parents: 17338 diff changeset	42 delete (cf);
ffa7f1caab4e Clarify relationship of close, closereq. Rik <rik@octave.org> parents: 17338 diff changeset	43 endif
ffa7f1caab4e Clarify relationship of close, closereq. Rik <rik@octave.org> parents: 17338 diff changeset	44
6257 44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: diff changeset	45 endfunction
17338 1c89599167a6 maint: End m-files with 1 blank line. Rik <rik@octave.org> parents: 17122 diff changeset	46

Mercurial > octave-nkf

annotate scripts/plot/closereq.m @ 17444:ffa7f1caab4e