Mercurial > octave

changeset 21819:972a06f5fa02

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Clarify docs for waitbar (bug #48094) * waitbar.m: Add see also for delete. Explain what a waitbar is. Clarify that HWBAR is the same as H.
author Lachlan Andrew <lachlanbis@gmail.com>
date Fri, 03 Jun 2016 12:59:50 +1000
parents 7b0436d0f5be
children 96c56993e679
files scripts/gui/waitbar.m
diffstat 1 files changed, 6 insertions(+), 4 deletions(-) [+]
line wrap: on
line diff
--- a/scripts/gui/waitbar.m	Fri Jun 03 16:47:05 2016 -0400
+++ b/scripts/gui/waitbar.m	Fri Jun 03 12:59:50 2016 +1000
@@ -22,9 +22,9 @@
 ## @deftypefnx {} {@var{h} =} waitbar (@dots{}, "createcancelbtn", @var{fcn}, @dots{})
 ## @deftypefnx {} {@var{h} =} waitbar (@dots{}, @var{prop}, @var{val}, @dots{})
 ## @deftypefnx {} {} waitbar (@var{frac})
-## @deftypefnx {} {} waitbar (@var{frac}, @var{hwbar})
-## @deftypefnx {} {} waitbar (@var{frac}, @var{hwbar}, @var{msg})
-## Return a handle @var{h} to a new waitbar object.
+## @deftypefnx {} {} waitbar (@var{frac}, @var{h})
+## @deftypefnx {} {} waitbar (@var{frac}, @var{h}, @var{msg})
+## Return a handle @var{h} to a new progress indicator ("waitbar") object.
 ##
 ## The waitbar is filled to fraction @var{frac} which must be in the range
 ## [0, 1].
@@ -41,8 +41,10 @@
 ##
 ## When called with a single input the current waitbar, if it exists, is
 ## updated to the new value @var{frac}.  If there are multiple outstanding
-## waitbars they can be updated individually by passing the handle @var{hwbar}
+## waitbars they can be updated individually by passing the handle @var{h}
 ## of the specific waitbar to modify.
+##
+## @seealso{delete}
 ## @end deftypefn
 
 ## Author: jwe