Mercurial > hg > octave-lyh
diff scripts/plot/comet3.m @ 16814:64e7bb01fce2
doc: Improve documentation for 2-D plot functions
* doc/interpreter/plot.txi: Rewrite documentation around get/set.
* libinterp/interpfcn/graphics.cc(Fget, Fset): Add seealso links. Add
additional calling forms for get().
* scripts/plot/bar.m, scripts/plot/barh.m, scripts/plot/comet.m,
scripts/plot/comet3.m, scripts/plot/contour.m, scripts/plot/contour3.m,
scripts/plot/contourc.m, scripts/plot/contourf.m, scripts/plot/errorbar.m,
scripts/plot/gca.m, scripts/plot/gcf.m, scripts/plot/gco.m,
scripts/plot/ishghandle.m, scripts/plot/loglogerr.m, scripts/plot/pareto.m,
scripts/plot/pcolor.m, scripts/plot/pie.m, scripts/plot/pie3.m,
scripts/plot/plotmatrix.m, scripts/plot/plotyy.m, scripts/plot/polar.m,
scripts/plot/quiver.m, scripts/plot/quiver3.m, scripts/plot/rose.m,
scripts/plot/scatter.m, scripts/plot/semilogxerr.m, scripts/plot/semilogyerr.m,
scripts/plot/sombrero.m, scripts/plot/stairs.m, scripts/plot/stem.m,
scripts/plot/stem3.m: Improve docstrings.
| author | Rik <rik@octave.org> |
|---|---|
| date | Sat, 22 Jun 2013 17:40:52 -0700 |
| parents | 5d3a684236b0 |
| children | a4969508008e |
line wrap: on
line diff
--- a/scripts/plot/comet3.m +++ b/scripts/plot/comet3.m @@ -18,18 +18,20 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} comet3 (@var{z}) +## @deftypefnx {Function File} {} comet3 (@var{x}, @var{y}, @var{z}) ## @deftypefnx {Function File} {} comet3 (@var{x}, @var{y}, @var{z}, @var{p}) -## @deftypefnx {Function File} {} comet3 (@var{ax}, @dots{}) +## @deftypefnx {Function File} {} comet3 (@var{hax}, @dots{}) ## Produce a simple comet style animation along the trajectory provided by -## the input coordinate vectors (@var{x}, @var{y}), where @var{x} will default -## to the indices of @var{y}. +## the input coordinate vectors (@var{x}, @var{y}, @var{z}). If only @var{z} +## is specified then @var{x}, @var{y} default to the indices of @var{z}. ## ## The speed of the comet may be controlled by @var{p}, which represents the -## time which passes as the animation passes from one point to the next. The -## default for @var{p} is 0.1 seconds. +## time each point is displayed before moving tothe next one. The default for +## @var{p} is 0.1 seconds. ## -## If @var{ax} is specified the animation is produced in that axis rather than -## the @code{gca}. +## If @var{hax} is specified the animation is produced in that axis rather than +## the current axis. +## @seealso{comet} ## @end deftypefn ## Author: jwe