# HG changeset patch # User Rik # Date 1375490254 25200 # Node ID 52931d71400f2e534588ba22ac00708c4a6c246f # Parent 6e8c621c34969fca40406364d42bfae6ea952b57 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. diff -r 6e8c621c3496 -r 52931d71400f scripts/plot/feather.m --- a/scripts/plot/feather.m Fri Aug 02 17:35:52 2013 -0700 +++ b/scripts/plot/feather.m Fri Aug 02 17:37:34 2013 -0700 @@ -20,7 +20,7 @@ ## @deftypefn {Function File} {} feather (@var{u}, @var{v}) ## @deftypefnx {Function File} {} feather (@var{z}) ## @deftypefnx {Function File} {} feather (@dots{}, @var{style}) -## @deftypefnx {Function File} {} feather (@var{h}, @dots{}) +## @deftypefnx {Function File} {} feather (@var{hax}, @dots{}) ## @deftypefnx {Function File} {@var{h} =} feather (@dots{}) ## ## Plot the @code{(@var{u}, @var{v})} components of a vector field emanating @@ -32,6 +32,9 @@ ## The style to use for the plot can be defined with a line style @var{style} ## of the same format as the @code{plot} command. ## +## 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 vector of graphics handles to the ## line objects representing the drawn vectors. ## diff -r 6e8c621c3496 -r 52931d71400f scripts/plot/hggroup.m --- a/scripts/plot/hggroup.m Fri Aug 02 17:35:52 2013 -0700 +++ b/scripts/plot/hggroup.m Fri Aug 02 17:37:34 2013 -0700 @@ -25,7 +25,7 @@ ## ## If no parent is specified, the group is created in the current axes. ## -## Multiple property-value pairs may be specified for the hggroup, but they +## Multiple property/value pairs may be specified for the hggroup, but they ## must appear in pairs. ## ## The optional return value @var{h} is a graphics handle to the created diff -r 6e8c621c3496 -r 52931d71400f scripts/plot/loglogerr.m --- a/scripts/plot/loglogerr.m Fri Aug 02 17:35:52 2013 -0700 +++ b/scripts/plot/loglogerr.m Fri Aug 02 17:37:34 2013 -0700 @@ -34,6 +34,9 @@ ## with errors in the @var{y}-scale defined by @var{ey} and the plot ## format defined by @var{fmt}. @xref{XREFerrorbar,,errorbar}, for available ## formats and additional information. +## +## If the first argument @var{hax} is an axes handle, then plot into this axis, +## rather than the current axes returned by @code{gca}. ## @seealso{errorbar, semilogxerr, semilogyerr} ## @end deftypefn diff -r 6e8c621c3496 -r 52931d71400f scripts/plot/quiver.m --- a/scripts/plot/quiver.m Fri Aug 02 17:35:52 2013 -0700 +++ b/scripts/plot/quiver.m Fri Aug 02 17:37:34 2013 -0700 @@ -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. diff -r 6e8c621c3496 -r 52931d71400f scripts/plot/quiver3.m --- a/scripts/plot/quiver3.m Fri Aug 02 17:35:52 2013 -0700 +++ b/scripts/plot/quiver3.m Fri Aug 02 17:37:34 2013 -0700 @@ -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. diff -r 6e8c621c3496 -r 52931d71400f scripts/plot/semilogxerr.m --- a/scripts/plot/semilogxerr.m Fri Aug 02 17:35:52 2013 -0700 +++ b/scripts/plot/semilogxerr.m Fri Aug 02 17:37:34 2013 -0700 @@ -35,6 +35,10 @@ ## with errors in the @var{y}-scale defined by @var{ey} and the plot ## format defined by @var{fmt}. @xref{XREFerrorbar,,errorbar}, for available ## formats and additional information. +## +## If the first argument @var{hax} is an axes handle, then plot into this axis, +## rather than the current axes returned by @code{gca}. +## ## @seealso{errorbar, semilogyerr, loglogerr} ## @end deftypefn diff -r 6e8c621c3496 -r 52931d71400f scripts/plot/semilogyerr.m --- a/scripts/plot/semilogyerr.m Fri Aug 02 17:35:52 2013 -0700 +++ b/scripts/plot/semilogyerr.m Fri Aug 02 17:37:34 2013 -0700 @@ -35,6 +35,10 @@ ## with errors in the @var{y}-scale defined by @var{ey} and the plot ## format defined by @var{fmt}. @xref{XREFerrorbar,,errorbar}, for available ## formats and additional information. +## +## If the first argument @var{hax} is an axes handle, then plot into this axis, +## rather than the current axes returned by @code{gca}. +## ## @seealso{errorbar, semilogxerr, loglogerr} ## @end deftypefn