diff scripts/plot/quiver.m @ 17169:52931d71400f

doc: Document that first argument can be an axes handle for several plot functions. * scripts/plot/feather.m, scripts/plot/hggroup.m, scripts/plot/loglogerr.m, scripts/plot/quiver.m, scripts/plot/quiver3.m, scripts/plot/semilogxerr.m, scripts/plot/semilogyerr.m: Document that first argument can be an axes handle for several plot functions.
author Rik <rik@octave.org>
date Fri, 02 Aug 2013 17:37:34 -0700
parents eaab03308c0b
children 87ba70043bfc
line wrap: on
line diff
--- a/scripts/plot/quiver.m
+++ b/scripts/plot/quiver.m
@@ -22,7 +22,7 @@
 ## @deftypefnx {Function File} {} quiver (@dots{}, @var{s})
 ## @deftypefnx {Function File} {} quiver (@dots{}, @var{style})
 ## @deftypefnx {Function File} {} quiver (@dots{}, "filled")
-## @deftypefnx {Function File} {} quiver (@var{h}, @dots{})
+## @deftypefnx {Function File} {} quiver (@var{hax}, @dots{})
 ## @deftypefnx {Function File} {@var{h} =} quiver (@dots{})
 ##
 ## Plot the (@var{u}, @var{v}) components of a vector field in
@@ -43,6 +43,9 @@
 ## drawn rather than arrows.  If the argument "filled" is given then the
 ## markers are filled.
 ##
+## If the first argument @var{hax} is an axes handle, then plot into this axis,
+## rather than the current axes returned by @code{gca}.
+##
 ## The optional return value @var{h} is a graphics handle to a quiver object.
 ## A quiver object regroups the components of the quiver plot (body, arrow,
 ## and marker), and allows them to be changed together.