Mercurial > hg > octave-lyh

comparison scripts/plot/daspect.m @ 16491:b10a23fe80bb

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Tweak docstrings of functions changed for Texinfo 5.0 compatibility. * 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/splinefit.m, scripts/set/union.m, scripts/signal/freqz.m: Improve docstring wording.
author Rik <rik@octave.org>
date Wed, 10 Apr 2013 22:43:30 -0700
parents 36dba9be680b
children eaab03308c0b
comparison
equal deleted inserted replaced
16490:f50fe9c50f55 16491:b10a23fe80bb
15 ## You should have received a copy of the GNU General Public License 15 ## You should have received a copy of the GNU General Public License
16 ## along with Octave; see the file COPYING. If not, see 16 ## along with Octave; see the file COPYING. If not, see
17 ## <http://www.gnu.org/licenses/>. 17 ## <http://www.gnu.org/licenses/>.
18 18
19 ## -*- texinfo -*- 19 ## -*- texinfo -*-
20 ## @deftypefn {Function File} {} daspect (@var{data_aspect_ratio}) 20 ## @deftypefn {Function File} {@var{data_aspect_ratio} =} daspect ()
21 ## @deftypefnx {Function File} {@var{data_aspect_ratio} =} daspect () 21 ## @deftypefnx {Function File} {} daspect (@var{data_aspect_ratio})
22 ## @deftypefnx {Function File} {} daspect (@var{mode}) 22 ## @deftypefnx {Function File} {} daspect (@var{mode})
23 ## @deftypefnx {Function File} {@var{data_aspect_ratio_mode} =} daspect ("mode") 23 ## @deftypefnx {Function File} {@var{data_aspect_ratio_mode} =} daspect ("mode")
24 ## @deftypefnx {Function File} {} daspect (@var{hax}, @dots{}) 24 ## @deftypefnx {Function File} {} daspect (@var{hax}, @dots{})
25 ## @code{daspect} sets the data aspect ratio of the current axes. The aspect 25 ## Query or set the data aspect ratio of the current axes. The aspect
26 ## ratio is a normalized 3-element vector representing the span of the x, y, and 26 ## ratio is a normalized 3-element vector representing the span of the x, y,
27 ## z-axes limits. 27 ## and z-axis limits.
28 ## 28 ##
29 ## When called without any arguments it returns data aspect ratio of the current axes. 29 ## @code{(daspect (@var{mode}))}
30 ##
31 ## Set the data aspect ratio mode of the current axes. @var{mode} is
32 ## either "auto" or "manual".
30 ## 33 ##
31 ## @code{(daspect (@var{mode}))} sets the data aspect ratio mode of the current axes. 34 ## @code{daspect ("mode")}
35 ##
36 ## Return the data aspect ratio mode of the current axes.
32 ## 37 ##
33 ## @code{daspect ("mode")} returns the data aspect ratio mode of the current axes. 38 ## @code{daspect (@var{hax}, @dots{})}
34 ## 39 ##
35 ## @code{daspect (@var{hax}, @dots{})} uses the axes, with handle @var{hax}, 40 ## Operate on the axes in handle @var{hax} instead of the current axes.
36 ## instead of the current axes.
37 ## 41 ##
38 ## @seealso{axis, pbaspect, xlim, ylim, zlim} 42 ## @seealso{axis, pbaspect, xlim, ylim, zlim}
39 ## @end deftypefn 43 ## @end deftypefn
40 44
41 ## Author: Ben Abbott <bpabbott@mac.com> 45 ## Author: Ben Abbott <bpabbott@mac.com>