Mercurial > hg > octave-nkf
changeset 10736:14af8004945d
stairs.m: Add additional calling forms to documentation
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Wed, 30 Jun 2010 21:07:18 -0700 |
parents | d899b2ee6a37 |
children | 5faf6832855a |
files | scripts/ChangeLog scripts/plot/stairs.m |
diffstat | 2 files changed, 8 insertions(+), 1 deletions(-) [+] |
line wrap: on
line diff
--- a/scripts/ChangeLog +++ b/scripts/ChangeLog @@ -1,3 +1,7 @@ +2010-06-16 Rik <octave@nomad.inbox5.com> + + * plot/stairs.m: Add additional calling forms to documentation. + 2010-06-24 John W. Eaton <jwe@octave.org> * plot/private/__plt__.m: Replace usage message with error.
--- a/scripts/plot/stairs.m +++ b/scripts/plot/stairs.m @@ -18,16 +18,19 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} stairs (@var{x}, @var{y}) +## @deftypefn {Function File} {} stairs (@var{y}) +## @deftypefnx {Function File} {} stairs (@var{x}, @var{y}) ## @deftypefnx {Function File} {} stairs (@dots{}, @var{style}) ## @deftypefnx {Function File} {} stairs (@dots{}, @var{prop}, @var{val}) ## @deftypefnx {Function File} {} stairs (@var{h}, @dots{}) ## @deftypefnx {Function File} {@var{h} =} stairs (@dots{}) +## @deftypefnx {Function File} {[@var{xstep}, @var{ystep}] =} stairs (@dots{}) ## Produce a stairstep plot. The arguments may be vectors or matrices. ## ## 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. ## +## If one output argument is requested, return a graphics handle to the plot. ## If two output arguments are specified, the data are generated but ## not plotted. For example, ##