Mercurial > octave
diff scripts/plot/appearance/axis.m @ 20173:777f26aa8e3e stable
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 |
line wrap: on
line diff
--- a/scripts/plot/appearance/axis.m Sat May 09 17:19:30 2015 -0700 +++ b/scripts/plot/appearance/axis.m Sat May 09 22:50:09 2015 -0700 @@ -39,9 +39,8 @@ ## With one output argument, @code{@var{limits} = axis} returns the current ## axis limits. ## -## The vector argument specifying limits is optional, and additional -## string arguments may be used to specify various axis properties. For -## example, +## The vector argument specifying limits is optional, and additional string +## arguments may be used to specify various axis properties. For example, ## ## @example ## axis ([1, 2, 3, 4], "square"); @@ -55,8 +54,7 @@ ## @end example ## ## @noindent -## turns tic marks on for all axes and tic mark labels on for the y-axis -## only. +## turns tic marks on for all axes and tic mark labels on for the y-axis only. ## ## @noindent ## The following options control the aspect ratio of the axes. @@ -77,8 +75,8 @@ ## ## @table @asis ## @item @qcode{"auto"} -## Set the specified axes to have nice limits around the data -## or all if no axes are specified. +## Set the specified axes to have nice limits around the data or all if no +## axes are specified. ## ## @item @qcode{"manual"} ## Fix the current axes limits. @@ -101,12 +99,12 @@ ## Turn tic marks off for all axes. ## ## @item @qcode{"tic[xyz]"} -## Turn tic marks on for all axes, or turn them on for the -## specified axes and off for the remainder. +## Turn tic marks on for all axes, or turn them on for the specified axes and +## off for the remainder. ## ## @item @qcode{"label[xyz]"} -## Turn tic labels on for all axes, or turn them on for the -## specified axes and off for the remainder. +## Turn tic labels on for all axes, or turn them on for the specified axes +## and off for the remainder. ## ## @item @qcode{"nolabel"} ## Turn tic labels off for all axes. @@ -125,8 +123,8 @@ ## Restore y-axis, so higher values are nearer the top. ## @end table ## -## If the first argument @var{hax} is an axes handle, then operate on -## this axes rather than the current axes returned by @code{gca}. +## If the first argument @var{hax} is an axes handle, then operate on this +## axes rather than the current axes returned by @code{gca}. ## ## @seealso{xlim, ylim, zlim, daspect, pbaspect, box, grid} ## @end deftypefn