Mercurial > octave-nkf
diff doc/interpreter/plot.txi @ 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 | 81e041f5633a |
children | 5d08a2ec7edb |
line wrap: on
line diff
--- a/doc/interpreter/plot.txi Sat Jun 22 14:36:42 2013 -0700 +++ b/doc/interpreter/plot.txi Sat Jun 22 17:40:52 2013 -0700 @@ -949,21 +949,21 @@ @code{line}, @code{text}, @code{patch}, @code{surface}, and @code{image} objects. -Graphics handles may be distinguished from function handles (@ref{Function -Handles}) by means of the function @code{ishandle}. @code{ishandle} returns -true if its argument is a handle of a graphics object. In addition, the figure -object may be tested using @code{isfigure}. @code{isfigure} returns true only -if its argument is a handle of a figure. ishghandle() is synonymous with -ishandle(). The @code{whos} function can be used to show the object type of -each currently defined graphics handle. (Note: this is not true today, but it -is, I hope, considered an error in whos. It may be better to have whos just -show graphics_handle as the class, and provide a new function which, given a +Graphics handles may be distinguished from function handles +(@ref{Function Handles}) by means of the function @code{ishandle}. +@code{ishandle} returns true if its argument is a handle of a graphics object. +In addition, the figure object may be tested using @code{isfigure}. +@code{isfigure} returns true only if its argument is a handle of a figure. The +@code{whos} function can be used to show the object type of each currently +defined graphics handle. (Note: this is not true today, but it is, I hope, +considered an error in whos. It may be better to have whos just show +graphics_handle as the class, and provide a new function which, given a graphics handle, returns its object type. This could generalize the ishandle() functions and, in fact, replace them.) -The @code{get} and @code{set} commands are -used to obtain and set the values of properties of graphics objects. In -addition, the @code{get} command may be used to obtain property names. +The @code{get} and @code{set} commands are used to obtain and set the values of +properties of graphics objects. In addition, the @code{get} command may be +used to obtain property names. For example, the property "type" of the graphics object pointed to by the graphics handle h may be displayed by: @@ -1037,7 +1037,7 @@ @cindex root figure graphics object @cindex graphics object, root figure the top level of the hierarchy and the parent of all figure objects. -The @code{handle} index of the root figure is 0. +The handle index of the root figure is 0. @item figure @cindex figure graphics object