Mercurial > hg > octave-nkf
comparison scripts/plot/barh.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 | eaab03308c0b |
comparison
equal
deleted
inserted
replaced
| 16813:81e041f5633a | 16814:64e7bb01fce2 |
|---|---|
| 19 ## -*- texinfo -*- | 19 ## -*- texinfo -*- |
| 20 ## @deftypefn {Function File} {} barh (@var{x}, @var{y}) | 20 ## @deftypefn {Function File} {} barh (@var{x}, @var{y}) |
| 21 ## @deftypefnx {Function File} {} barh (@var{y}) | 21 ## @deftypefnx {Function File} {} barh (@var{y}) |
| 22 ## @deftypefnx {Function File} {} barh (@var{x}, @var{y}, @var{w}) | 22 ## @deftypefnx {Function File} {} barh (@var{x}, @var{y}, @var{w}) |
| 23 ## @deftypefnx {Function File} {} barh (@var{x}, @var{y}, @var{w}, @var{style}) | 23 ## @deftypefnx {Function File} {} barh (@var{x}, @var{y}, @var{w}, @var{style}) |
| 24 ## @deftypefnx {Function File} {@var{h} =} barh (@dots{}, @var{prop}, @var{val}) | 24 ## @deftypefnx {Function File} {} barh (@dots{}, @var{prop}, @var{val}) |
| 25 ## @deftypefnx {Function File} {} barh (@var{h}, @dots{}) | 25 ## @deftypefnx {Function File} {} barh (@var{h}, @dots{}) |
| 26 ## @deftypefnx {Function File} {@var{h} =} barh (@dots{}) | |
| 26 ## Produce a horizontal bar graph from two vectors of x-y data. | 27 ## Produce a horizontal bar graph from two vectors of x-y data. |
| 27 ## | 28 ## |
| 28 ## If only one argument is given, it is taken as a vector of y-values | 29 ## If only one argument is given, it is taken as a vector of y-values |
| 29 ## and the x coordinates are taken to be the indices of the elements. | 30 ## and the x coordinates are taken to be the indices of the elements. |
| 30 ## | 31 ## |
| 34 ## separate bar graph plotted on the same graph. By default the columns | 35 ## separate bar graph plotted on the same graph. By default the columns |
| 35 ## are plotted side-by-side. This behavior can be changed by the @var{style} | 36 ## are plotted side-by-side. This behavior can be changed by the @var{style} |
| 36 ## argument, which can take the values @code{"grouped"} (the default), | 37 ## argument, which can take the values @code{"grouped"} (the default), |
| 37 ## or @code{"stacked"}. | 38 ## or @code{"stacked"}. |
| 38 ## | 39 ## |
| 39 ## The optional input handle @var{h} allows an axis handle to be passed. | 40 ## Passing the optional input handle @var{h} will draw the resulting plot |
| 41 ## in the specified handle. | |
| 42 ## | |
| 40 ## Properties of the patch graphics object can be changed using | 43 ## Properties of the patch graphics object can be changed using |
| 41 ## @var{prop}, @var{val} pairs. | 44 ## @var{prop}, @var{val} pairs. |
| 42 ## | 45 ## |
| 43 ## The optional return value @var{h} is a graphics handle to the created | 46 ## The optional return value @var{h} is a graphics handle to the created |
| 44 ## bar series object. See @code{bar} for a description of the use of the | 47 ## bar series object. See @code{bar} for a description of the use of the |