Mercurial > hg > octave-terminal
changeset 11315:c715816f4539
Add additional calling form to docstring for [xyz]label functions.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Mon, 06 Dec 2010 17:30:47 -0800 |
parents | 87f258202b0f |
children | b7ff4a51ea88 |
files | scripts/ChangeLog scripts/plot/xlabel.m scripts/plot/ylabel.m scripts/plot/zlabel.m |
diffstat | 4 files changed, 13 insertions(+), 4 deletions(-) [+] |
line wrap: on
line diff
--- a/scripts/ChangeLog +++ b/scripts/ChangeLog @@ -1,3 +1,8 @@ +2010-12-06 Rik <octave@nomad.inbox5.com> + + * plot/xlabel.m, plot/ylabel.m, plot/zlabel.m: Add additional calling + form to docstring which returns handle (h) + 2010-12-06 Rik <octave@nomad.inbox5.com> * scripts/testfun/speed.m: Overhaul documentation string.
--- a/scripts/plot/xlabel.m +++ b/scripts/plot/xlabel.m @@ -19,11 +19,13 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} xlabel (@var{string}) -## @deftypefnx {Function File} {} ylabel (@var{string}) -## @deftypefnx {Function File} {} zlabel (@var{string}) ## @deftypefnx {Function File} {} xlabel (@var{h}, @var{string}) -## Specify x-, y-, and z-axis labels for the current figure. If @var{h} is -## specified then label the axis defined by @var{h}. +## @deftypefnx {Function File} {@var{h} =} xlabel (@dots{}) +## @deftypefnx {Function File} {} ylabel (@dots{}) +## @deftypefnx {Function File} {} zlabel (@dots{}) +## Specify x-, y-, or z-axis labels for the current axis. If @var{h} is +## specified then label the axis defined by @var{h}. The optional return +## value @var{h} provides a handle to the created label. ## @seealso{plot, semilogx, semilogy, loglog, polar, mesh, contour, ## bar, stairs, title} ## @end deftypefn
--- a/scripts/plot/ylabel.m +++ b/scripts/plot/ylabel.m @@ -20,6 +20,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} ylabel (@var{string}) ## @deftypefnx {Function File} {} ylabel (@var{h}, @var{string}) +## @deftypefnx {Function File} {@var{h} =} ylabel (@dots{}) ## @seealso{xlabel} ## @end deftypefn
--- a/scripts/plot/zlabel.m +++ b/scripts/plot/zlabel.m @@ -20,6 +20,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} zlabel (@var{string}) ## @deftypefnx {Function File} {} zlabel (@var{h}, @var{string}) +## @deftypefnx {Function File} {@var{h} =} zlabel (@dots{}) ## @seealso{xlabel} ## @end deftypefn