Mercurial > hg > octave-nkf
diff scripts/plot/pbaspect.m @ 16489:36dba9be680b
doc: Make documentation compatible with Texinfo 5.0 (bug #38392)
* scripts/audio/wavread.m, scripts/miscellaneous/getappdata.m,
scripts/miscellaneous/license.m, scripts/miscellaneous/ver.m,
scripts/plot/daspect.m, scripts/plot/graphics_toolkit.m,
scripts/plot/pbaspect.m, scripts/polynomial/polyval.m,
scripts/polynomial/splinefit.m, scripts/set/union.m, scripts/signal/freqz.m:
Moved @deftypefnx entries to always immediately follow @deftypefn.
| author | Amod Mulay <amodmulay1@gmail.com> |
|---|---|
| date | Fri, 22 Mar 2013 17:07:00 -0400 |
| parents | 4506eade9f04 |
| children | b10a23fe80bb |
line wrap: on
line diff
--- a/scripts/plot/pbaspect.m +++ b/scripts/plot/pbaspect.m @@ -18,21 +18,24 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} pbaspect (@var{plot_box_aspect_ratio}) +## @deftypefnx {Function File} {@var{plot_box_aspect_ratio} =} pbaspect ( ) +## @deftypefnx {Function File} {} pbaspect (@var{mode}) +## @deftypefnx {Function File} {@var{plot_box_aspect_ratio_mode} =} pbaspect ("mode") +## @deftypefnx {Function File} {} pbaspect (@var{hax}, @dots{}) +## ## Set the plot box aspect ratio of the current axes. The aspect ratio ## is a normalized 3-element vector representing the rendered lengths of ## the x, y, and z-axes. -## -## @deftypefnx {Function File} {@var{plot_box_aspect_ratio} =} pbaspect ( ) -## Return the plot box aspect ratio of the current axes. -## -## @deftypefnx {Function File} {} pbaspect (@var{mode}) -## Set the plot box aspect ratio mode of the current axes. -## -## @deftypefnx {Function File} {@var{plot_box_aspect_ratio_mode} =} pbaspect ("mode") -## Return the plot box aspect ratio mode of the current axes. -## -## @deftypefnx {Function File} {} pbaspect (@var{hax}, @dots{}) -## Use the axes, with handle @var{hax}, instead of the current axes. +## +## When called without any arguments, returns the plot box aspect ratio of +## the current axes. +## +## @code{pbaspect(@var{mode})} sets the plot box aspect ratio mode of the current axes. +## +## @code{pbaspect ("mode")} returns the plot box aspect ratio mode of the current axes. +## +## @code{pbaspect (@var{hax}, @dots{})} uses the axes, with handle @var{hax}, instead +## of the current axes. ## ## @seealso{axis, daspect, xlim, ylim, zlim} ## @end deftypefn