Just noticed that the return value of midend_process_key() wasn't

documented.

[originally from svn r8062]

diff --git a/devel.but b/devel.but
index e481ec6311bca011881328df67186860bf5f6c5b..ea23d520d5a8b81a7e72505f900b38755e186103 100644 (file)
--- a/devel.but
+++ b/devel.but
@@ -2671,6 +2671,11 @@ Calling this function is very likely to result in calls back to the
 front end's drawing API and/or \cw{activate_timer()}
 (\k{frontend-activate-timer}).
 
+The return value from \cw{midend_process_key()} is non-zero, unless
+the effect of the keypress was to request termination of the
+program. A front end should shut down the puzzle in response to a
+zero return.
+
 \H{midend-colours} \cw{midend_colours()}
 
 \c float *midend_colours(midend *me, int *ncolours);