Mercurial > octave-nkf

changeset 17483:710309214e0d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Add seealso links between waitfor, waitforbuttonpress, and ginput. * libinterp/corefcn/graphics.cc(Fwaitfor): Put objective of function in first line of docstring. Add seealso link to waitforbuttonpress. * scripts/plot/ginput.m: Add seealso link to waitforbuttonpress. * scripts/plot/waitforbuttonpress.m: Add seealso link to kbhit.
author Rik <rik@octave.org>
date Wed, 25 Sep 2013 10:09:33 -0700
parents e5b0cf1fcf6a
children 995decfed6cc
files libinterp/corefcn/graphics.cc scripts/plot/ginput.m scripts/plot/waitforbuttonpress.m
diffstat 3 files changed, 10 insertions(+), 9 deletions(-) [+]
line wrap: on
line diff
--- a/libinterp/corefcn/graphics.cc	Wed Sep 25 18:58:27 2013 +0200
+++ b/libinterp/corefcn/graphics.cc	Wed Sep 25 10:09:33 2013 -0700
@@ -10207,11 +10207,12 @@
 @deftypefnx {Built-in Function} {} waitfor (@var{h}, @var{prop}, @var{value})\n\
 @deftypefnx {Built-in Function} {} waitfor (@dots{}, \"timeout\", @var{timeout})\n\
 Suspend the execution of the current program until a condition is\n\
-satisfied on the graphics handle @var{h}.  While the program is suspended\n\
-graphics events are still being processed normally, allowing callbacks to\n\
-modify the state of graphics objects.  This function is reentrant and can be\n\
-called from a callback, while another @code{waitfor} call is pending at\n\
-top-level.\n\
+satisfied on the graphics handle @var{h}.\n\
+\n\
+While the program is suspended graphics events are still being processed\n\
+normally, allowing callbacks to modify the state of graphics objects.  This\n\
+function is reentrant and can be called from a callback, while another\n\
+@code{waitfor} call is pending at the top-level.\n\
 \n\
 In the first form, program execution is suspended until the graphics object\n\
 @var{h} is destroyed.  If the graphics handle is invalid, the function\n\
@@ -10238,7 +10239,7 @@
 @code{\\timeout} instead.\n\
 \n\
 In all cases, typing CTRL-C stops program execution immediately.\n\
-@seealso{isequal}\n\
+@seealso{waitforbuttonpress, isequal}\n\
 @end deftypefn")
 {
   if (args.length () > 0)
@@ -10406,7 +10407,7 @@
 
           // FIXME: There is still a "hole" in the following loop. The code
           //        assumes that an object handle is unique, which is a fair
-          //        assumptions, except for figures. If a figure is destroyed
+          //        assumption, except for figures. If a figure is destroyed
           //        then recreated with the same figure ID, within the same
           //        run of event hooks, then the figure destruction won't be
           //        caught and the loop will not stop. This is an unlikely
--- a/scripts/plot/ginput.m	Wed Sep 25 18:58:27 2013 +0200
+++ b/scripts/plot/ginput.m	Wed Sep 25 10:09:33 2013 -0700
@@ -30,7 +30,7 @@
 ## was clicked in the units of the current axes.  The return value @var{button}
 ## is 1, 2, or 3 for the left, middle, or right button.  If a key is pressed
 ## the ASCII value is returned in @var{button}.
-## @seealso{gtext}
+## @seealso{gtext, waitforbuttonpress}
 ## @end deftypefn
 
 function varargout = ginput (n)
--- a/scripts/plot/waitforbuttonpress.m	Wed Sep 25 18:58:27 2013 +0200
+++ b/scripts/plot/waitforbuttonpress.m	Wed Sep 25 10:09:33 2013 -0700
@@ -23,7 +23,7 @@
 ##
 ## The return value of @var{b} is 0 if a mouse button was pressed or 1 if a
 ## key was pressed.
-## @seealso{waitfor, ginput}
+## @seealso{waitfor, ginput, kbhit}
 ## @end deftypefn
 
 ## The original version of this code bore the copyright