Mercurial > hg > octave-nkf
annotate scripts/plot/gcf.m @ 16814:64e7bb01fce2
doc: Improve documentation for 2-D plot functions
* doc/interpreter/plot.txi: Rewrite documentation around get/set.
* libinterp/interpfcn/graphics.cc(Fget, Fset): Add seealso links. Add
additional calling forms for get().
* scripts/plot/bar.m, scripts/plot/barh.m, scripts/plot/comet.m,
scripts/plot/comet3.m, scripts/plot/contour.m, scripts/plot/contour3.m,
scripts/plot/contourc.m, scripts/plot/contourf.m, scripts/plot/errorbar.m,
scripts/plot/gca.m, scripts/plot/gcf.m, scripts/plot/gco.m,
scripts/plot/ishghandle.m, scripts/plot/loglogerr.m, scripts/plot/pareto.m,
scripts/plot/pcolor.m, scripts/plot/pie.m, scripts/plot/pie3.m,
scripts/plot/plotmatrix.m, scripts/plot/plotyy.m, scripts/plot/polar.m,
scripts/plot/quiver.m, scripts/plot/quiver3.m, scripts/plot/rose.m,
scripts/plot/scatter.m, scripts/plot/semilogxerr.m, scripts/plot/semilogyerr.m,
scripts/plot/sombrero.m, scripts/plot/stairs.m, scripts/plot/stem.m,
scripts/plot/stem3.m: Improve docstrings.
| author | Rik <rik@octave.org> |
|---|---|
| date | Sat, 22 Jun 2013 17:40:52 -0700 |
| parents | f3d52523cde1 |
| children | eaab03308c0b |
| rev | line source |
|---|---|
|
14138
72c96de7a403
maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents:
13141
diff
changeset
|
1 ## Copyright (C) 2005-2012 John W. Eaton |
| 6257 | 2 ## |
| 3 ## This file is part of Octave. | |
| 4 ## | |
| 5 ## Octave is free software; you can redistribute it and/or modify it | |
| 6 ## under the terms of the GNU General Public License as published by | |
| 7016 | 7 ## the Free Software Foundation; either version 3 of the License, or (at |
| 8 ## your option) any later version. | |
| 6257 | 9 ## |
| 10 ## Octave is distributed in the hope that it will be useful, but | |
| 11 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 13 ## General Public License for more details. | |
| 14 ## | |
| 15 ## You should have received a copy of the GNU General Public License | |
| 7016 | 16 ## along with Octave; see the file COPYING. If not, see |
| 17 ## <http://www.gnu.org/licenses/>. | |
| 6257 | 18 |
| 19 ## -*- texinfo -*- | |
|
16814
64e7bb01fce2
doc: Improve documentation for 2-D plot functions
Rik <rik@octave.org>
parents:
14363
diff
changeset
|
20 ## @deftypefn {Function File} {@var{h} =} gcf () |
| 6895 | 21 ## Return the current figure handle. If a figure does not exist, create |
| 22 ## one and return its handle. The handle may then be used to examine or | |
| 23 ## set properties of the figure. For example, | |
| 24 ## | |
| 25 ## @example | |
| 26 ## @group | |
| 27 ## fplot (@@sin, [-10, 10]); | |
| 28 ## fig = gcf (); | |
| 29 ## set (fig, "visible", "off"); | |
| 30 ## @end group | |
| 31 ## @end example | |
| 32 ## | |
| 33 ## @noindent | |
| 34 ## plots a sine wave, finds the handle of the current figure, and then | |
| 35 ## makes that figure invisible. Setting the visible property of the | |
| 36 ## figure to @code{"on"} will cause it to be displayed again. | |
|
16814
64e7bb01fce2
doc: Improve documentation for 2-D plot functions
Rik <rik@octave.org>
parents:
14363
diff
changeset
|
37 ## @seealso{gca, gco, get, set} |
| 6257 | 38 ## @end deftypefn |
| 39 | |
| 40 ## Author: jwe, Bill Denney | |
| 41 | |
| 42 function h = gcf () | |
| 43 | |
| 44 if (nargin == 0) | |
| 45 h = get (0, "currentfigure"); | |
| 46 if (isempty (h) || h == 0) | |
| 47 ## We only have a root figure object, so create a new figure | |
| 48 ## object and make it the current figure. | |
| 49 h = figure (1); | |
| 50 endif | |
| 51 else | |
| 52 print_usage (); | |
| 53 endif | |
| 54 | |
| 55 endfunction | |
| 13096 | 56 |
|
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
57 |
| 13096 | 58 %!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
|
59 %! 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
|
60 %! unwind_protect |
|
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
|
61 %! assert (gcf, hf); |
| 13096 | 62 %! unwind_protect_cleanup |
| 63 %! close (hf); | |
| 64 %! end_unwind_protect | |
|
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
65 |