From 50136f43c7de4889444d9de19ff5d99f2cc04bf7 Mon Sep 17 00:00:00 2001
From: Thierry Crozat
Date: Sun, 1 Jul 2012 01:03:49 +0100
Subject: COMMON: Expand a bit the KeyState documentation

This follows a bug that was found in the Lure engine where keycode
was used in a place where it should have used ascii.
---
 common/keyboard.h | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

(limited to 'common')

diff --git a/common/keyboard.h b/common/keyboard.h
index e6db086598..f9e94e6656 100644
--- a/common/keyboard.h
+++ b/common/keyboard.h
@@ -248,7 +248,10 @@ struct KeyState {
 	 * ASCII-value of the pressed key (if any).
 	 * This depends on modifiers, i.e. pressing the 'A' key results in
 	 * different values here depending on the status of shift, alt and
-	 * caps lock.
+	 * caps lock. This should be used rather than keycode for text input
+	 * to avoid keyboard layout issues. For example you cannot assume that
+	 * KEYCODE_0 without a modifier will be '0' (on AZERTY keyboards it is
+	*  not).
 	 */
 	uint16 ascii;
 
-- 
cgit v1.2.3