Mercurial > hg > octave-lyh
diff scripts/plot/bar.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 | de751531e548 |
| children | 53d6166f7867 |
line wrap: on
line diff
--- a/scripts/plot/bar.m +++ b/scripts/plot/bar.m @@ -21,8 +21,8 @@ ## @deftypefnx {Function File} {} bar (@var{y}) ## @deftypefnx {Function File} {} bar (@var{x}, @var{y}, @var{w}) ## @deftypefnx {Function File} {} bar (@var{x}, @var{y}, @var{w}, @var{style}) +## @deftypefnx {Function File} {} bar (@var{h}, @dots{}) ## @deftypefnx {Function File} {@var{h} =} bar (@dots{}, @var{prop}, @var{val}) -## @deftypefnx {Function File} {} bar (@var{h}, @dots{}) ## Produce a bar graph from two vectors of x-y data. ## ## If only one argument is given, @var{y}, it is taken as a vector of y-values @@ -36,6 +36,9 @@ ## 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. +## ## The optional return value @var{h} is a handle to the created "bar series" ## object with one handle per column of the variable @var{y}. This ## series allows common elements of the group of bar series objects to @@ -52,8 +55,6 @@ ## @noindent ## changes the position on the base of all of the bar series. ## -## The optional input handle @var{h} allows an axis handle to be passed. -## ## The bar graph's appearance may be modified by specifying property/value ## pairs. The following example modifies the face and edge colors. ##