diff scripts/plot/barh.m @ 7096:81bed50b9feb

[project @ 2007-11-02 16:13:43 by jwe]
author jwe
date Fri, 02 Nov 2007 16:13:44 +0000
parents 625891845df5
children 33ed85dcfaa8
line wrap: on
line diff
--- a/scripts/plot/barh.m	Thu Nov 01 17:37:21 2007 +0000
+++ b/scripts/plot/barh.m	Fri Nov 02 16:13:44 2007 +0000
@@ -17,36 +17,28 @@
 ## <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn {Function File} {@var{h} =} barh (@var{x}, @var{y}, @var{style})
-## @deftypefnx {Function File} {[@var{xb}, @var{yb}] =} barh (@dots{})
-## Given two vectors of x-y data, @code{bar} produce a horizontal bar graph.
+## @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} {@var{h} =} barh (...,@var{prop}, @var{val})
+## 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.
 ##
+## The default width of 0.8 for the bars can be changed using @var{w}. 
+##
 ## 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
 ## are plotted side-by-side. This behavior can be changed by the @var{style}
 ## argument, which can take the values @code{"grouped"} (the default),
 ## or @code{"stacked"}.
 ##
-## If two output arguments are specified, the data are generated but
-## not plotted.  For example,
-##
-## @example
-## barh (x, y);
-## @end example
+## The optional return value @var{h} provides a handle to the patch object.
+## Properties of the patch graphics object can be changed using 
+## @var{prop}, @var{val} pairs.
 ##
-## @noindent
-## and
-##
-## @example
-## [xb, yb] = barh (x, y);
-## plot (xb, yb);
-## @end example
-##
-## @noindent
-## are equivalent.
 ## @seealso{bar, plot}
 ## @end deftypefn