annotate scripts/plot/barh.m @ 15063:36cbcc37fdb8

Refactor configure.ac to make it more understandable. Use common syntax for messages in config.h Correct typos, refer to libraries in all caps, use two spaces after period. Follow Autoconf guidelines and place general tests before specific tests. * configure.ac, m4/acinclude.m4: Use common syntax for messages in config.h Correct typos, refer to libraries in all caps, use two spaces after period. Follow Autoconf guidelines and place general tests before specific tests.
author Rik <rik@octave.org>
date Tue, 31 Jul 2012 10:28:51 -0700
parents 72c96de7a403
children de751531e548
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14138
72c96de7a403 maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents: 14001
diff changeset
1 ## Copyright (C) 1996-2012 John W. Eaton
6633
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman]
dbateman
parents:
diff changeset
2 ##
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman]
dbateman
parents:
diff changeset
3 ## This file is part of Octave.
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman]
dbateman
parents:
diff changeset
4 ##
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman]
dbateman
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman]
dbateman
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6895
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6895
diff changeset
8 ## your option) any later version.
6633
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman]
dbateman
parents:
diff changeset
9 ##
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman]
dbateman
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman]
dbateman
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman]
dbateman
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman]
dbateman
parents:
diff changeset
13 ## General Public License for more details.
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman]
dbateman
parents:
diff changeset
14 ##
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman]
dbateman
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6895
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6895
diff changeset
17 ## <http://www.gnu.org/licenses/>.
6633
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman]
dbateman
parents:
diff changeset
18
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman]
dbateman
parents:
diff changeset
19 ## -*- texinfo -*-
10793
be55736a0783 Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents: 9245
diff changeset
20 ## @deftypefn {Function File} {} barh (@var{x}, @var{y})
7106
33ed85dcfaa8 [project @ 2007-11-06 18:03:08 by jwe]
jwe
parents: 7096
diff changeset
21 ## @deftypefnx {Function File} {} barh (@var{y})
33ed85dcfaa8 [project @ 2007-11-06 18:03:08 by jwe]
jwe
parents: 7096
diff changeset
22 ## @deftypefnx {Function File} {} barh (@var{x}, @var{y}, @var{w})
33ed85dcfaa8 [project @ 2007-11-06 18:03:08 by jwe]
jwe
parents: 7096
diff changeset
23 ## @deftypefnx {Function File} {} barh (@var{x}, @var{y}, @var{w}, @var{style})
33ed85dcfaa8 [project @ 2007-11-06 18:03:08 by jwe]
jwe
parents: 7096
diff changeset
24 ## @deftypefnx {Function File} {@var{h} =} barh (@dots{}, @var{prop}, @var{val})
7189
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7106
diff changeset
25 ## @deftypefnx {Function File} {} barh (@var{h}, @dots{})
7096
81bed50b9feb [project @ 2007-11-02 16:13:43 by jwe]
jwe
parents: 7086
diff changeset
26 ## Produce a horizontal bar graph from two vectors of x-y data.
6633
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman]
dbateman
parents:
diff changeset
27 ##
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman]
dbateman
parents:
diff changeset
28 ## If only one argument is given, it is taken as a vector of y-values
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman]
dbateman
parents:
diff changeset
29 ## and the x coordinates are taken to be the indices of the elements.
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman]
dbateman
parents:
diff changeset
30 ##
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
31 ## The default width of 0.8 for the bars can be changed using @var{w}.
7096
81bed50b9feb [project @ 2007-11-02 16:13:43 by jwe]
jwe
parents: 7086
diff changeset
32 ##
6633
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman]
dbateman
parents:
diff changeset
33 ## If @var{y} is a matrix, then each column of @var{y} is taken to be a
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
34 ## separate bar graph plotted on the same graph. By default the columns
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
35 ## are plotted side-by-side. This behavior can be changed by the @var{style}
7086
625891845df5 [project @ 2007-10-31 17:11:49 by jwe]
jwe
parents: 7017
diff changeset
36 ## argument, which can take the values @code{"grouped"} (the default),
625891845df5 [project @ 2007-10-31 17:11:49 by jwe]
jwe
parents: 7017
diff changeset
37 ## or @code{"stacked"}.
6633
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman]
dbateman
parents:
diff changeset
38 ##
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 7189
diff changeset
39 ## The optional input handle @var{h} allows an axis handle to be passed.
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 7189
diff changeset
40 ## Properties of the patch graphics object can be changed using
7096
81bed50b9feb [project @ 2007-11-02 16:13:43 by jwe]
jwe
parents: 7086
diff changeset
41 ## @var{prop}, @var{val} pairs.
6633
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman]
dbateman
parents:
diff changeset
42 ##
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
43 ## The optional return value @var{h} is a graphics handle to the created
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
44 ## bar series object. See @code{bar} for a description of the use of the
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
45 ## bar series.
6895
76e3d985ae56 [project @ 2007-09-13 18:22:38 by jwe]
jwe
parents: 6633
diff changeset
46 ## @seealso{bar, plot}
6633
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman]
dbateman
parents:
diff changeset
47 ## @end deftypefn
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman]
dbateman
parents:
diff changeset
48
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman]
dbateman
parents:
diff changeset
49 ## Author: jwe
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman]
dbateman
parents:
diff changeset
50
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman]
dbateman
parents:
diff changeset
51 function varargout = barh (varargin)
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman]
dbateman
parents:
diff changeset
52 varargout = cell (nargout, 1);
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman]
dbateman
parents:
diff changeset
53 [varargout{:}] = __bar__ (false, "barh", varargin{:});
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman]
dbateman
parents:
diff changeset
54 endfunction
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
55
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
56
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
57 %% FIXME: Need demo or test for function
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
58