Mercurial > octave-nkf

comparison scripts/gui/waitbar.m @ 20208: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 9fc020886ae9
children ae68b331d6e4
comparison
equal deleted inserted replaced
20207:4f45eaf83908 20208:777f26aa8e3e
24 ## @deftypefnx {Function File} {} waitbar (@var{frac}, @var{hwbar}) 24 ## @deftypefnx {Function File} {} waitbar (@var{frac}, @var{hwbar})
25 ## @deftypefnx {Function File} {} waitbar (@var{frac}, @var{hwbar}, @var{msg}) 25 ## @deftypefnx {Function File} {} waitbar (@var{frac}, @var{hwbar}, @var{msg})
26 ## Return a handle @var{h} to a new waitbar object. 26 ## Return a handle @var{h} to a new waitbar object.
27 ## 27 ##
28 ## The waitbar is filled to fraction @var{frac} which must be in the range 28 ## The waitbar is filled to fraction @var{frac} which must be in the range
29 ## [0, 1]. The optional message @var{msg} is centered and displayed above the 29 ## [0, 1].
30 ## waitbar. The appearance of the waitbar figure window can be configured by 30 ##
31 ## passing property/value pairs to the function. 31 ## The optional message @var{msg} is centered and displayed above the waitbar.
32 ##
33 ## The appearance of the waitbar figure window can be configured by passing
34 ## property/value pairs to the function.
32 ## 35 ##
33 ## When called with a single input the current waitbar, if it exists, is 36 ## When called with a single input the current waitbar, if it exists, is
34 ## updated to the new value @var{frac}. If there are multiple outstanding 37 ## updated to the new value @var{frac}. If there are multiple outstanding
35 ## waitbars they can be updated individually by passing the handle @var{hwbar} 38 ## waitbars they can be updated individually by passing the handle @var{hwbar}
36 ## of the specific waitbar to modify. 39 ## of the specific waitbar to modify.