Mercurial > hg > octave-nkf

comparison scripts/plot/pbaspect.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 6a1aa61b5b16
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} {} pbaspect (@var{plot_box_aspect_ratio}) 20 ## @deftypefn {Function File} {@var{plot_box_aspect_ratio} =} pbaspect ( )
21 ## @deftypefnx {Function File} {@var{plot_box_aspect_ratio} =} pbaspect ( ) 21 ## @deftypefnx {Function File} {} pbaspect (@var{plot_box_aspect_ratio})
22 ## @deftypefnx {Function File} {} pbaspect (@var{mode}) 22 ## @deftypefnx {Function File} {} pbaspect (@var{mode})
23 ## @deftypefnx {Function File} {@var{plot_box_aspect_ratio_mode} =} pbaspect ("mode") 23 ## @deftypefnx {Function File} {@var{plot_box_aspect_ratio_mode} =} pbaspect ("mode")
24 ## @deftypefnx {Function File} {} pbaspect (@var{hax}, @dots{}) 24 ## @deftypefnx {Function File} {} pbaspect (@var{hax}, @dots{})
25 ## 25 ##
26 ## Set the plot box aspect ratio of the current axes. The aspect ratio 26 ## Query or set the plot box aspect ratio of the current axes. The aspect
27 ## is a normalized 3-element vector representing the rendered lengths of 27 ## ratio is a normalized 3-element vector representing the rendered lengths of
28 ## the x, y, and z-axes. 28 ## the x, y, and z axes.
29 ## 29 ##
30 ## When called without any arguments, returns the plot box aspect ratio of 30 ## @code{pbaspect(@var{mode})}
31 ## the current axes. 31 ##
32 ## 32 ## Set the plot box aspect ratio mode of the current axes. @var{mode} is
33 ## @code{pbaspect(@var{mode})} sets the plot box aspect ratio mode of the current axes. 33 ## either "auto" or "manual".
34 ## 34 ##
35 ## @code{pbaspect ("mode")} returns the plot box aspect ratio mode of the current axes. 35 ## @code{pbaspect ("mode")}
36 ## 36 ##
37 ## @code{pbaspect (@var{hax}, @dots{})} uses the axes, with handle @var{hax}, instead 37 ## Return the plot box aspect ratio mode of the current axes.
38 ## of the current axes. 38 ##
39 ## @code{pbaspect (@var{hax}, @dots{})}
40 ##
41 ## Operate on the axes in handle @var{hax} instead of the current axes.
39 ## 42 ##
40 ## @seealso{axis, daspect, xlim, ylim, zlim} 43 ## @seealso{axis, daspect, xlim, ylim, zlim}
41 ## @end deftypefn 44 ## @end deftypefn
42 45
43 ## Author: Ben Abbott <bpabbott@mac.com> 46 ## Author: Ben Abbott <bpabbott@mac.com>