Mercurial > hg > octave-nkf

diff scripts/plot/util/zoom.m @ 20383: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 065ccb9a1324
children
line wrap: on
line diff
--- a/scripts/plot/util/zoom.m
+++ b/scripts/plot/util/zoom.m
@@ -26,31 +26,30 @@
 ## @deftypefnx {Command} {} zoom out
 ## @deftypefnx {Command} {} zoom reset
 ## @deftypefnx {Command} {} zoom (@var{hfig}, @var{option})
-## Zoom the current axes object or control the interactive zoom mode of
-## a figure in the GUI.
+## Zoom the current axes object or control the interactive zoom mode of a
+## figure in the GUI.
 ##
-## Given a numeric argument greater than zero, zoom by the given factor.
-## If the zoom factor is greater than one, zoom in on the plot.  If the
-## factor is less than one, zoom out.  If the zoom factor is a two- or
-## three-element vector, then the elements specify the zoom factors for
-## the x, y, and z axes respectively.
+## Given a numeric argument greater than zero, zoom by the given factor.  If
+## the zoom factor is greater than one, zoom in on the plot.  If the factor
+## is less than one, zoom out.  If the zoom factor is a two- or three-element
+## vector, then the elements specify the zoom factors for the x, y, and z
+## axes respectively.
 ##
-## Given the option @qcode{"on"} or @qcode{"off"}, set the interactive
-## zoom mode on or off.
+## Given the option @qcode{"on"} or @qcode{"off"}, set the interactive zoom
+## mode on or off.
 ##
 ## With no arguments, toggle the current zoom mode on or off.
 ##
-## Given the option @qcode{"xon"} or @qcode{"yon"}, enable zoom mode
-## for the x or y axis only.
+## Given the option @qcode{"xon"} or @qcode{"yon"}, enable zoom mode for the
+## x or y-axis only.
 ##
 ## Given the option @qcode{"out"}, zoom to the initial zoom setting.
 ##
-## Given the option @qcode{"reset"}, store the current zoom setting so
-## that @code{zoom out} will return to this zoom level.
+## Given the option @qcode{"reset"}, store the current zoom setting so that
+## @code{zoom out} will return to this zoom level.
 ##
-## If the first argument @var{hfig} is a figure, then operate on
-## the given figure rather than the current figure as returned by
-## @code{gcf}.
+## If the first argument @var{hfig} is a figure, then operate on the given
+## figure rather than the current figure as returned by @code{gcf}.
 ##
 ## @seealso{pan, rotate3d}
 ## @end deftypefn