Mercurial > hg > octave-lyh
diff scripts/plot/daspect.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/daspect.m +++ b/scripts/plot/daspect.m @@ -18,22 +18,23 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} daspect (@var{data_aspect_ratio}) -## Set the data aspect ratio of the current axes. The aspect ratio is -## a normalized 3-element vector representing the span of the x, y, and -## z-axes limits. -## -## @deftypefnx {Function File} {@var{data_aspect_ratio} =} daspect ( ) -## Return the data aspect ratio of the current axes. -## +## @deftypefnx {Function File} {@var{data_aspect_ratio} =} daspect () ## @deftypefnx {Function File} {} daspect (@var{mode}) -## Set the data aspect ratio mode of the current axes. -## ## @deftypefnx {Function File} {@var{data_aspect_ratio_mode} =} daspect ("mode") -## Return the data aspect ratio mode of the current axes. -## ## @deftypefnx {Function File} {} daspect (@var{hax}, @dots{}) -## Use the axes, with handle @var{hax}, instead of the current axes. -## +## @code{daspect} sets the data aspect ratio of the current axes. The aspect +## ratio is a normalized 3-element vector representing the span of the x, y, and +## z-axes limits. +## +## When called without any arguments it returns data aspect ratio of the current axes. +## +## @code{(daspect (@var{mode}))} sets the data aspect ratio mode of the current axes. +## +## @code{daspect ("mode")} returns the data aspect ratio mode of the current axes. +## +## @code{daspect (@var{hax}, @dots{})} uses the axes, with handle @var{hax}, +## instead of the current axes. +## ## @seealso{axis, pbaspect, xlim, ylim, zlim} ## @end deftypefn