Mercurial > octave

comparison scripts/plot/appearance/axis.m @ 20173:777f26aa8e3e stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Update more docstrings to have one sentence summary as first line. Reviewed plot/ and gui/ in scripts directory. * scripts/gui/errordlg.m, scripts/gui/helpdlg.m, scripts/gui/inputdlg.m, scripts/gui/listdlg.m, scripts/gui/msgbox.m, scripts/gui/private/__get_funcname__.m, scripts/gui/private/__uiobject_split_args__.m, scripts/gui/questdlg.m, scripts/gui/uigetdir.m, scripts/gui/uigetfile.m, scripts/gui/uiwait.m, scripts/gui/waitbar.m, scripts/gui/warndlg.m, scripts/plot/appearance/annotation.m, scripts/plot/appearance/axis.m, scripts/plot/appearance/box.m, scripts/plot/appearance/caxis.m, scripts/plot/appearance/datetick.m, scripts/plot/appearance/hidden.m, scripts/plot/appearance/legend.m, scripts/plot/appearance/xlim.m, scripts/plot/appearance/ylim.m, scripts/plot/appearance/zlim.m, scripts/plot/draw/area.m, scripts/plot/draw/comet.m, scripts/plot/draw/comet3.m, scripts/plot/draw/contour.m, scripts/plot/draw/contourf.m, scripts/plot/draw/isocolors.m, scripts/plot/draw/isonormals.m, scripts/plot/draw/isosurface.m, scripts/plot/draw/plotmatrix.m, scripts/plot/draw/quiver.m, scripts/plot/draw/quiver3.m, scripts/plot/draw/ribbon.m, scripts/plot/draw/semilogxerr.m, scripts/plot/draw/semilogyerr.m, scripts/plot/draw/sphere.m, scripts/plot/draw/surfl.m, scripts/plot/draw/tetramesh.m, scripts/plot/util/allchild.m, scripts/plot/util/ancestor.m, scripts/plot/util/axes.m, scripts/plot/util/colstyle.m, scripts/plot/util/frame2im.m, scripts/plot/util/gnuplot_binary.in, scripts/plot/util/hgsave.m, scripts/plot/util/im2frame.m, scripts/plot/util/isaxes.m, scripts/plot/util/isfigure.m, scripts/plot/util/linkaxes.m, scripts/plot/util/ndgrid.m, scripts/plot/util/pan.m, scripts/plot/util/print.m, scripts/plot/util/printd.m, scripts/plot/util/private/__add_default_menu__.m, scripts/plot/util/rotate.m, scripts/plot/util/rotate3d.m, scripts/plot/util/saveas.m, scripts/plot/util/struct2hdl.m, scripts/plot/util/subplot.m, scripts/plot/util/zoom.m: Update more docstrings to have one sentence summary as first line.
author Rik <rik@octave.org>
date Sat, 09 May 2015 22:50:09 -0700
parents f25fe5369022
children 83792dd9bcc1
comparison
equal deleted inserted replaced
20172:4f45eaf83908 20173:777f26aa8e3e
37 ## Without any arguments, @code{axis} turns autoscaling on. 37 ## Without any arguments, @code{axis} turns autoscaling on.
38 ## 38 ##
39 ## With one output argument, @code{@var{limits} = axis} returns the current 39 ## With one output argument, @code{@var{limits} = axis} returns the current
40 ## axis limits. 40 ## axis limits.
41 ## 41 ##
42 ## The vector argument specifying limits is optional, and additional 42 ## The vector argument specifying limits is optional, and additional string
43 ## string arguments may be used to specify various axis properties. For 43 ## arguments may be used to specify various axis properties. For example,
44 ## example,
45 ## 44 ##
46 ## @example 45 ## @example
47 ## axis ([1, 2, 3, 4], "square"); 46 ## axis ([1, 2, 3, 4], "square");
48 ## @end example 47 ## @end example
49 ## 48 ##
53 ## @example 52 ## @example
54 ## axis ("tic", "labely"); 53 ## axis ("tic", "labely");
55 ## @end example 54 ## @end example
56 ## 55 ##
57 ## @noindent 56 ## @noindent
58 ## turns tic marks on for all axes and tic mark labels on for the y-axis 57 ## turns tic marks on for all axes and tic mark labels on for the y-axis only.
59 ## only.
60 ## 58 ##
61 ## @noindent 59 ## @noindent
62 ## The following options control the aspect ratio of the axes. 60 ## The following options control the aspect ratio of the axes.
63 ## 61 ##
64 ## @table @asis 62 ## @table @asis
75 ## @noindent 73 ## @noindent
76 ## The following options control the way axis limits are interpreted. 74 ## The following options control the way axis limits are interpreted.
77 ## 75 ##
78 ## @table @asis 76 ## @table @asis
79 ## @item @qcode{"auto"} 77 ## @item @qcode{"auto"}
80 ## Set the specified axes to have nice limits around the data 78 ## Set the specified axes to have nice limits around the data or all if no
81 ## or all if no axes are specified. 79 ## axes are specified.
82 ## 80 ##
83 ## @item @qcode{"manual"} 81 ## @item @qcode{"manual"}
84 ## Fix the current axes limits. 82 ## Fix the current axes limits.
85 ## 83 ##
86 ## @item @qcode{"tight"} 84 ## @item @qcode{"tight"}
99 ## 97 ##
100 ## @item @qcode{"off"} 98 ## @item @qcode{"off"}
101 ## Turn tic marks off for all axes. 99 ## Turn tic marks off for all axes.
102 ## 100 ##
103 ## @item @qcode{"tic[xyz]"} 101 ## @item @qcode{"tic[xyz]"}
104 ## Turn tic marks on for all axes, or turn them on for the 102 ## Turn tic marks on for all axes, or turn them on for the specified axes and
105 ## specified axes and off for the remainder. 103 ## off for the remainder.
106 ## 104 ##
107 ## @item @qcode{"label[xyz]"} 105 ## @item @qcode{"label[xyz]"}
108 ## Turn tic labels on for all axes, or turn them on for the 106 ## Turn tic labels on for all axes, or turn them on for the specified axes
109 ## specified axes and off for the remainder. 107 ## and off for the remainder.
110 ## 108 ##
111 ## @item @qcode{"nolabel"} 109 ## @item @qcode{"nolabel"}
112 ## Turn tic labels off for all axes. 110 ## Turn tic labels off for all axes.
113 ## @end table 111 ## @end table
114 ## 112 ##
123 ## 121 ##
124 ## @item @qcode{"xy"} 122 ## @item @qcode{"xy"}
125 ## Restore y-axis, so higher values are nearer the top. 123 ## Restore y-axis, so higher values are nearer the top.
126 ## @end table 124 ## @end table
127 ## 125 ##
128 ## If the first argument @var{hax} is an axes handle, then operate on 126 ## If the first argument @var{hax} is an axes handle, then operate on this
129 ## this axes rather than the current axes returned by @code{gca}. 127 ## axes rather than the current axes returned by @code{gca}.
130 ## 128 ##
131 ## @seealso{xlim, ylim, zlim, daspect, pbaspect, box, grid} 129 ## @seealso{xlim, ylim, zlim, daspect, pbaspect, box, grid}
132 ## @end deftypefn 130 ## @end deftypefn
133 131
134 ## Author: jwe 132 ## Author: jwe