Mercurial > hg > octave-lyh

comparison scripts/plot/xlim.m @ 17454:9e4e24a0a118

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Use common language for xlim, ylim, zlim docstrings. * scripts/plot/xlim.m, scripts/plot/ylim.m, scripts/plot/zlim.m: Use common language for xlim, ylim, zlim docstrings.
author Rik <rik@octave.org>
date Thu, 19 Sep 2013 14:03:11 -0700
parents bc924baa2c4e
children
comparison
equal deleted inserted replaced
17453:2fee3022ac2f 17454:9e4e24a0a118
21 ## @deftypefnx {Function File} {@var{xmode} =} xlim ("mode") 21 ## @deftypefnx {Function File} {@var{xmode} =} xlim ("mode")
22 ## @deftypefnx {Function File} {} xlim ([@var{x_lo} @var{x_hi}]) 22 ## @deftypefnx {Function File} {} xlim ([@var{x_lo} @var{x_hi}])
23 ## @deftypefnx {Function File} {} xlim ("auto") 23 ## @deftypefnx {Function File} {} xlim ("auto")
24 ## @deftypefnx {Function File} {} xlim ("manual") 24 ## @deftypefnx {Function File} {} xlim ("manual")
25 ## @deftypefnx {Function File} {} xlim (@var{hax}, @dots{}) 25 ## @deftypefnx {Function File} {} xlim (@var{hax}, @dots{})
26 ## Query or set the limits of the x-axis of the current plot. 26 ## Query or set the limits of the x-axis for the current plot.
27 ## 27 ##
28 ## Called without arguments @code{xlim} returns the x-axis limits of the 28 ## Called without arguments @code{xlim} returns the x-axis limits of the
29 ## current plot. With the input query @qcode{"mode"}, return the current 29 ## current plot. With the input query @qcode{"mode"}, return the current
30 ## x-limit calculation mode which is either @qcode{"auto"} or 30 ## x-limit calculation mode which is either @qcode{"auto"} or @qcode{"manual"}.
31 ## @qcode{"manual"}.
32 ## 31 ##
33 ## If passed a 2-element vector [@var{x_lo} @var{x_hi}], the limits of the 32 ## If passed a 2-element vector [@var{x_lo} @var{x_hi}], the limits of the
34 ## x-axis are set to these values. 33 ## x-axis are set to these values and the mode is set to @qcode{"manual"}.
35 ## 34 ##
36 ## The current plotting mode can be set by passing either @qcode{"auto"} or 35 ## The current plotting mode can be changed by using either @qcode{"auto"}
37 ## @qcode{"manual"} as the argument. 36 ## or @qcode{"manual"} as the argument.
38 ## 37 ##
39 ## If the first argument @var{hax} is an axes handle, then operate on 38 ## If the first argument @var{hax} is an axes handle, then operate on
40 ## this axis rather than the current axes returned by @code{gca}. 39 ## this axis rather than the current axes returned by @code{gca}.
41 ## @seealso{ylim, zlim, axis, set, get, gca} 40 ## @seealso{ylim, zlim, axis, set, get, gca}
42 ## @end deftypefn 41 ## @end deftypefn