From 502847f59ef01c78a85e4ee5453a09d9b83d9a5e Mon Sep 17 00:00:00 2001
From: Sven Gothel <sgothel@jausoft.com>
Date: Wed, 31 Oct 2012 21:58:36 +0100
Subject: NEWT KeyEvent API doc: Document Windows shift+non-uppecase_char,
 commit c135d638fe820457977747e3d45960da64038d53

---
 src/newt/classes/com/jogamp/newt/event/KeyEvent.java | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

(limited to 'src/newt')

diff --git a/src/newt/classes/com/jogamp/newt/event/KeyEvent.java b/src/newt/classes/com/jogamp/newt/event/KeyEvent.java
index 927c9aa85..289aa31f6 100644
--- a/src/newt/classes/com/jogamp/newt/event/KeyEvent.java
+++ b/src/newt/classes/com/jogamp/newt/event/KeyEvent.java
@@ -73,7 +73,14 @@ public class KeyEvent extends InputEvent
         this.keyChar=keyChar;
     }
 
-    /** Returns the character matching the {@link #getKeyCode() virtual key code}, if exist. */
+    /** 
+     * Returns the character matching the {@link #getKeyCode() virtual key code}, if exist.
+     * <p>
+     * <b>Disclaimer</b>: Only valid on all platforms at {@link KeyListener#keyTyped(KeyEvent)}.
+     * Precisely, on the Windows platform we currently cannot deliver the proper character
+     * in case of shifted keys where no uppercase exists, e.g. 'shift + 1' doesn't produce '!'.
+     * </p> 
+     */
     public char getKeyChar() {
         return keyChar;
     }
-- 
cgit v1.2.3