Mercurial > octave-antonio
comparison scripts/plot/gtext.m @ 17122:eaab03308c0b
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 | 20cac6006005 |
| children |
comparison
equal
deleted
inserted
replaced
| 17121:d4549655b92e | 17122:eaab03308c0b |
|---|---|
| 18 | 18 |
| 19 ## -*- texinfo -*- | 19 ## -*- texinfo -*- |
| 20 ## @deftypefn {Function File} {} gtext (@var{s}) | 20 ## @deftypefn {Function File} {} gtext (@var{s}) |
| 21 ## @deftypefnx {Function File} {} gtext (@{@var{s1}, @var{s2}, @dots{}@}) | 21 ## @deftypefnx {Function File} {} gtext (@{@var{s1}, @var{s2}, @dots{}@}) |
| 22 ## @deftypefnx {Function File} {} gtext (@{@var{s1}; @var{s2}; @dots{}@}) | 22 ## @deftypefnx {Function File} {} gtext (@{@var{s1}; @var{s2}; @dots{}@}) |
| 23 ## @deftypefnx {Function File} {} gtext (@dots{}, @var{prop}, @var{val}) | 23 ## @deftypefnx {Function File} {} gtext (@dots{}, @var{prop}, @var{val}, @dots{}) |
| 24 ## @deftypefnx {Function File} {@var{h} =} gtext (@dots{}) | 24 ## @deftypefnx {Function File} {@var{h} =} gtext (@dots{}) |
| 25 ## Place text on the current figure using the mouse. The text is defined | 25 ## Place text on the current figure using the mouse. |
| 26 ## by the string @var{s}. If @var{s} is a cell string organized as a row | 26 ## |
| 27 ## vector then each string of the cell array is written to a separate line. | 27 ## The text is defined by the string @var{s}. If @var{s} is a cell string |
| 28 ## If @var{s} is organized as a column vector then one string element of the | 28 ## organized as a row vector then each string of the cell array is written to a |
| 29 ## cell array is placed for every mouse click. Additional inputs besides a | 29 ## separate line. If @var{s} is organized as a column vector then one string |
| 30 ## string or cellstr are passed to the underlying text object as Property-value | 30 ## element of the cell array is placed for every mouse click. |
| 31 ## pairs. | 31 ## |
| 32 ## Optional property/value pairs are passed directly to the underlying text | |
| 33 ## objects. | |
| 32 ## | 34 ## |
| 33 ## The optional return value @var{h} is a graphics handle to the created | 35 ## The optional return value @var{h} is a graphics handle to the created |
| 34 ## text object. | 36 ## text object(s). |
| 35 ## @seealso{ginput, text} | 37 ## @seealso{ginput, text} |
| 36 ## @end deftypefn | 38 ## @end deftypefn |
| 37 | 39 |
| 38 function h = gtext (s, varargin) | 40 function h = gtext (s, varargin) |
| 39 | 41 |