From 14197de8e658cce23a53d7ca9b8fcc3bd323530b Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Thu, 3 Aug 2017 12:15:37 +0200 Subject: [PATCH] Add a few words about masking as in-code comments. Signed-off-by: Gergely Nagy --- src/Kaleidoscope-Hardware-Model01.h | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/src/Kaleidoscope-Hardware-Model01.h b/src/Kaleidoscope-Hardware-Model01.h index d8c47e22..2e58fd23 100644 --- a/src/Kaleidoscope-Hardware-Model01.h +++ b/src/Kaleidoscope-Hardware-Model01.h @@ -30,6 +30,15 @@ class Model01 { boolean ledPowerFault(void); + /* Key masking + * ----------- + * + * There are situations when one wants to ignore key events for a while, and + * mask them out. These functions help do that. In isolation, they do nothing, + * plugins and the core firmware is expected to make use of these. + * + * See `handleKeyswitchEvent` in the Kaleidoscope sources for a use-case. + */ void maskKey(byte row, byte col); void unMaskKey(byte row, byte col); bool isKeyMasked(byte row, byte col);