comparison scripts/gui/waitforbuttonpress.m @ 18917:f6468b8c6a74 stable

doc: Correct variable name in waitforbuttonpress docstring (bug #42768). * waitforbuttonpress.m: Rename variable in function definition from 'A' to 'B' to match rest of docstring.
author Rik <rik@octave.org>
date Mon, 14 Jul 2014 08:33:02 -0700
parents d63878346099
children
comparison
equal deleted inserted replaced
18916:5999e654f256 18917:f6468b8c6a74
16 ## along with Octave; see the file COPYING. If not, see 16 ## along with Octave; see the file COPYING. If not, see
17 ## <http://www.gnu.org/licenses/>. 17 ## <http://www.gnu.org/licenses/>.
18 18
19 ## -*- texinfo -*- 19 ## -*- texinfo -*-
20 ## @deftypefn {Function File} {} waitforbuttonpress () 20 ## @deftypefn {Function File} {} waitforbuttonpress ()
21 ## @deftypefnx {Function File} {@var{a} =} waitforbuttonpress () 21 ## @deftypefnx {Function File} {@var{b} =} waitforbuttonpress ()
22 ## Wait for mouse click or key press over the current figure window. 22 ## Wait for mouse click or key press over the current figure window.
23 ## 23 ##
24 ## The return value of @var{b} is 0 if a mouse button was pressed or 1 if a 24 ## The return value of @var{b} is 0 if a mouse button was pressed or 1 if a
25 ## key was pressed. 25 ## key was pressed.
26 ## @seealso{waitfor, ginput, kbhit} 26 ## @seealso{waitfor, ginput, kbhit}