Mercurial > hg > octave-lyh
diff scripts/plot/barh.m @ 17126: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 | 64e7bb01fce2 |
children | df4c4b7708a4 |
line wrap: on
line diff
--- a/scripts/plot/barh.m +++ b/scripts/plot/barh.m @@ -17,19 +17,21 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} barh (@var{x}, @var{y}) -## @deftypefnx {Function File} {} barh (@var{y}) -## @deftypefnx {Function File} {} barh (@var{x}, @var{y}, @var{w}) -## @deftypefnx {Function File} {} barh (@var{x}, @var{y}, @var{w}, @var{style}) -## @deftypefnx {Function File} {} barh (@dots{}, @var{prop}, @var{val}) -## @deftypefnx {Function File} {} barh (@var{h}, @dots{}) -## @deftypefnx {Function File} {@var{h} =} barh (@dots{}) -## Produce a horizontal bar graph from two vectors of x-y data. +## @deftypefn {Function File} {} barh (@var{y}) +## @deftypefnx {Function File} {} barh (@var{x}, @var{y}) +## @deftypefnx {Function File} {} barh (@dots{}, @var{w}) +## @deftypefnx {Function File} {} barh (@dots{}, @var{style}) +## @deftypefnx {Function File} {} barh (@dots{}, @var{prop}, @var{val}, @dots{}) +## @deftypefnx {Function File} {} barh (@var{hax}, @dots{}) +## @deftypefnx {Function File} {@var{h} =} barh (@dots{}, @var{prop}, @var{val}, @dots{}) +## Produce a horizontal bar graph from two vectors of X-Y data. ## -## If only one argument is given, it is taken as a vector of y-values -## and the x coordinates are taken to be the indices of the elements. +## If only one argument is given, it is taken as a vector of Y values +## and the X coordinates are the range @code{1:numel (@var{y})}. ## -## The default width of 0.8 for the bars can be changed using @var{w}. +## The optional input @var{w} controls the width of the bars. A value of +## 1.0 will cause each bar to exactly touch any adjacent bars. +## The default width is 0.8. ## ## If @var{y} is a matrix, then each column of @var{y} is taken to be a ## separate bar graph plotted on the same graph. By default the columns @@ -37,16 +39,16 @@ ## argument, which can take the values @code{"grouped"} (the default), ## or @code{"stacked"}. ## -## Passing the optional input handle @var{h} will draw the resulting plot -## in the specified handle. +## Optional property/value pairs are passed directly to the underlying patch +## objects. +## +## If the first argument @var{hax} is an axes handle, then plot into this axis, +## rather than the current axes returned by @code{gca}. ## -## Properties of the patch graphics object can be changed using -## @var{prop}, @var{val} pairs. -## ## The optional return value @var{h} is a graphics handle to the created -## bar series object. See @code{bar} for a description of the use of the -## bar series. -## @seealso{bar, plot} +## bar series hggroup. For a description of the use of the +## bar series, @pxref{XREFbar,,bar}. +## @seealso{bar, hist, pie, plot, patch} ## @end deftypefn ## Author: jwe