From: simon <simon@cda61777-01e9-0310-a592-d414129be87e>
Date: Tue, 10 Jun 2008 17:24:09 +0000 (+0000)
Subject: Just noticed that the return value of midend_process_key() wasn't
X-Git-Url: https://git.distorted.org.uk/~mdw/sgt/puzzles/commitdiff_plain/2ddfae80641ff95141e3a9e7f0b525b340345862

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


git-svn-id: svn://svn.tartarus.org/sgt/puzzles@8062 cda61777-01e9-0310-a592-d414129be87e
---

diff --git a/devel.but b/devel.but
index e481ec6..ea23d52 100644
--- 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);