NEWT KeyEvent API doc: Document Windows shift+non-uppecase_char, commit c135d638fe820457977747e3d45960da64038d53v2.0-rc11

1 files changed, 8 insertions, 1 deletions

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