Mercurial > hg > octave-lyh

comparison scripts/plot/stairs.m @ 10736:14af8004945d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
stairs.m: Add additional calling forms to documentation
author Rik <octave@nomad.inbox5.com>
date Wed, 30 Jun 2010 21:07:18 -0700
parents 95c3e38098bf
children a0dfd7e8e3e2
comparison
equal deleted inserted replaced
10735:d899b2ee6a37 10736:14af8004945d
16 ## You should have received a copy of the GNU General Public License 16 ## You should have received a copy of the GNU General Public License
17 ## along with Octave; see the file COPYING. If not, see 17 ## along with Octave; see the file COPYING. If not, see
18 ## <http://www.gnu.org/licenses/>. 18 ## <http://www.gnu.org/licenses/>.
19 19
20 ## -*- texinfo -*- 20 ## -*- texinfo -*-
21 ## @deftypefn {Function File} {} stairs (@var{x}, @var{y}) 21 ## @deftypefn {Function File} {} stairs (@var{y})
22 ## @deftypefnx {Function File} {} stairs (@var{x}, @var{y})
22 ## @deftypefnx {Function File} {} stairs (@dots{}, @var{style}) 23 ## @deftypefnx {Function File} {} stairs (@dots{}, @var{style})
23 ## @deftypefnx {Function File} {} stairs (@dots{}, @var{prop}, @var{val}) 24 ## @deftypefnx {Function File} {} stairs (@dots{}, @var{prop}, @var{val})
24 ## @deftypefnx {Function File} {} stairs (@var{h}, @dots{}) 25 ## @deftypefnx {Function File} {} stairs (@var{h}, @dots{})
25 ## @deftypefnx {Function File} {@var{h} =} stairs (@dots{}) 26 ## @deftypefnx {Function File} {@var{h} =} stairs (@dots{})
27 ## @deftypefnx {Function File} {[@var{xstep}, @var{ystep}] =} stairs (@dots{})
26 ## Produce a stairstep plot. The arguments may be vectors or matrices. 28 ## Produce a stairstep plot. The arguments may be vectors or matrices.
27 ## 29 ##
28 ## If only one argument is given, it is taken as a vector of y-values 30 ## 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. 31 ## and the x coordinates are taken to be the indices of the elements.
30 ## 32 ##
33 ## If one output argument is requested, return a graphics handle to the plot.
31 ## If two output arguments are specified, the data are generated but 34 ## If two output arguments are specified, the data are generated but
32 ## not plotted. For example, 35 ## not plotted. For example,
33 ## 36 ##
34 ## @example 37 ## @example
35 ## stairs (x, y); 38 ## stairs (x, y);