From: Simon Tatham <anakin@pobox.com>
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://www.chiark.greenend.org.uk/ucgi/~ian/git?a=commitdiff_plain;h=2066ddabd64ca9047ccc2c1071b38df14ec14ee0;p=sgt-puzzles.git

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 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);