Mercurial > hg > octave-nkf
comparison scripts/plot/ginput.m @ 13280:c60a059a18bc
doc: Use @key{} macro in ginput() documentation
ginput.m: Use @key{} macro in ginput() documentation.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Wed, 05 Oct 2011 16:46:16 -0700 |
parents | 6efa1a691713 |
children | 72c96de7a403 |
comparison
equal
deleted
inserted
replaced
13279:984359717d71 | 13280:c60a059a18bc |
---|---|
19 ## -*- texinfo -*- | 19 ## -*- texinfo -*- |
20 ## @deftypefn {Function File} {[@var{x}, @var{y}, @var{buttons}] =} ginput (@var{n}) | 20 ## @deftypefn {Function File} {[@var{x}, @var{y}, @var{buttons}] =} ginput (@var{n}) |
21 ## Return which mouse buttons were pressed and keys were hit on the current | 21 ## Return which mouse buttons were pressed and keys were hit on the current |
22 ## figure. If @var{n} is defined, then wait for @var{n} mouse clicks | 22 ## figure. If @var{n} is defined, then wait for @var{n} mouse clicks |
23 ## before returning. If @var{n} is not defined, then @code{ginput} will | 23 ## before returning. If @var{n} is not defined, then @code{ginput} will |
24 ## loop until the return key is pressed. | 24 ## loop until the return key @key{RET} is pressed. |
25 ## @end deftypefn | 25 ## @end deftypefn |
26 | 26 |
27 function varargout = ginput (n) | 27 function varargout = ginput (n) |
28 | 28 |
29 if (nargin > 1) | 29 if (nargin > 1) |