Mercurial > hg > octave-nkf
comparison scripts/plot/plot.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 | 08dd9458684a |
| children | df4c4b7708a4 |
comparison
equal
deleted
inserted
replaced
| 17121:d4549655b92e | 17122:eaab03308c0b |
|---|---|
| 19 ## -*- texinfo -*- | 19 ## -*- texinfo -*- |
| 20 ## @deftypefn {Function File} {} plot (@var{y}) | 20 ## @deftypefn {Function File} {} plot (@var{y}) |
| 21 ## @deftypefnx {Function File} {} plot (@var{x}, @var{y}) | 21 ## @deftypefnx {Function File} {} plot (@var{x}, @var{y}) |
| 22 ## @deftypefnx {Function File} {} plot (@var{x}, @var{y}, @var{property}, @var{value}, @dots{}) | 22 ## @deftypefnx {Function File} {} plot (@var{x}, @var{y}, @var{property}, @var{value}, @dots{}) |
| 23 ## @deftypefnx {Function File} {} plot (@var{x}, @var{y}, @var{fmt}) | 23 ## @deftypefnx {Function File} {} plot (@var{x}, @var{y}, @var{fmt}) |
| 24 ## @deftypefnx {Function File} {} plot (@var{h}, @dots{}) | 24 ## @deftypefnx {Function File} {} plot (@var{hax}, @dots{}) |
| 25 ## @deftypefnx {Function File} {@var{h} =} plot (@dots{}) | 25 ## @deftypefnx {Function File} {@var{h} =} plot (@dots{}) |
| 26 ## Produce two-dimensional plots. | 26 ## Produce 2-D plots. |
| 27 ## | 27 ## |
| 28 ## Many different combinations of arguments are possible. The simplest | 28 ## Many different combinations of arguments are possible. The simplest |
| 29 ## form is | 29 ## form is |
| 30 ## | 30 ## |
| 31 ## @example | 31 ## @example |
| 92 ## | 92 ## |
| 93 ## If both arguments are scalars, a single point is plotted. | 93 ## If both arguments are scalars, a single point is plotted. |
| 94 ## @end itemize | 94 ## @end itemize |
| 95 ## | 95 ## |
| 96 ## Multiple property-value pairs may be specified, but they must appear | 96 ## Multiple property-value pairs may be specified, but they must appear |
| 97 ## in pairs. These arguments are applied to the lines drawn by | 97 ## in pairs. These arguments are applied to the line objects drawn by |
| 98 ## @code{plot}. | 98 ## @code{plot}. |
| 99 ## | 99 ## |
| 100 ## If the @var{fmt} argument is supplied, it is interpreted as | 100 ## If the @var{fmt} argument is supplied, it is interpreted as |
| 101 ## follows. If @var{fmt} is missing, the default gnuplot line style | 101 ## follows. If @var{fmt} is missing, the default gnuplot line style |
| 102 ## is assumed. | 102 ## is assumed. |
| 123 ## or @code{"w"} (white), it is interpreted as the line plot color. | 123 ## or @code{"w"} (white), it is interpreted as the line plot color. |
| 124 ## | 124 ## |
| 125 ## @item ";title;" | 125 ## @item ";title;" |
| 126 ## Here @code{"title"} is the label for the key. | 126 ## Here @code{"title"} is the label for the key. |
| 127 ## | 127 ## |
| 128 ## @item + | 128 ## @item + |
| 129 ## @itemx * | 129 ## @itemx * |
| 130 ## @itemx o | 130 ## @itemx o |
| 131 ## @itemx x | 131 ## @itemx x |
| 132 ## @itemx ^ | 132 ## @itemx ^ |
| 133 ## Used in combination with the points or linespoints styles, set the point | 133 ## Used in combination with the points or linespoints styles, set the point |
| 168 ## @end example | 168 ## @end example |
| 169 ## | 169 ## |
| 170 ## This will plot the cosine and sine functions and label them accordingly | 170 ## This will plot the cosine and sine functions and label them accordingly |
| 171 ## in the key. | 171 ## in the key. |
| 172 ## | 172 ## |
| 173 ## If the first argument is an axis handle, then plot into these axes, | 173 ## If the first argument @var{hax} is an axes handle, then plot into this axis, |
| 174 ## rather than the current axis handle returned by @code{gca}. | 174 ## rather than the current axes returned by @code{gca}. |
| 175 ## | 175 ## |
| 176 ## The optional return value @var{h} is a graphics handle to the created plot. | 176 ## The optional return value @var{h} is a vector of graphics handles to |
| 177 ## | 177 ## the created line objects. |
| 178 ## @seealso{semilogx, semilogy, loglog, polar, mesh, contour, bar, | 178 ## |
| 179 ## stairs, errorbar, xlabel, ylabel, title, print} | 179 ## @seealso{axis, box, grid, hold, legend, title, xlabel, ylabel, xlim, ylim, ezplot, errorbar, fplot, line, plot3, polar, loglog, semilogx, semilogy, subplot} |
| 180 ## @end deftypefn | 180 ## @end deftypefn |
| 181 | 181 |
| 182 ## Author: jwe | 182 ## Author: jwe |
| 183 | 183 |
| 184 function h = plot (varargin) | 184 function h = plot (varargin) |