diff options
author | Purdea Andrei <andrei@purdea.ro> | 2021-10-01 00:24:19 +0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-10-01 07:24:19 +1000 |
commit | 52cb19713b794be130563ac20923e8e70e83971e (patch) | |
tree | 054aa3c27a5da5a5ad0667b4d70ba1100714952a | |
parent | 0be3cd3e2b8a7c5996f39166ab4a8afb986251ee (diff) | |
download | qmk_firmware-52cb19713b794be130563ac20923e8e70e83971e.tar.gz qmk_firmware-52cb19713b794be130563ac20923e8e70e83971e.zip |
Fix documentation for NO_HAPTIC_MOD and NO_HAPTIC_FN features. (#14180)
-rw-r--r-- | docs/feature_haptic_feedback.md | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/docs/feature_haptic_feedback.md b/docs/feature_haptic_feedback.md index 469c9c798..1f36f5b05 100644 --- a/docs/feature_haptic_feedback.md +++ b/docs/feature_haptic_feedback.md | |||
@@ -168,10 +168,16 @@ This mode sets continuous haptic feedback with the option to increase or decreas | |||
168 | The Haptic Exclusion is implemented as `__attribute__((weak)) bool get_haptic_enabled_key(uint16_t keycode, keyrecord_t *record)` in haptic.c. This allows a re-definition at the required level with the specific requirement / exclusion. | 168 | The Haptic Exclusion is implemented as `__attribute__((weak)) bool get_haptic_enabled_key(uint16_t keycode, keyrecord_t *record)` in haptic.c. This allows a re-definition at the required level with the specific requirement / exclusion. |
169 | 169 | ||
170 | ### NO_HAPTIC_MOD | 170 | ### NO_HAPTIC_MOD |
171 | With the entry of `#define NO_HAPTIC_MOD` in config.h, modifiers from Left Control to Right GUI will not trigger a feedback. This also includes modifiers in a Mod Tap configuration. | 171 | With the entry of `#define NO_HAPTIC_MOD` in config.h, the following keys will not trigger feedback: |
172 | |||
173 | * Usual modifier keys such as Control/Shift/Alt/Gui (For example `KC_LCTRL`) | ||
174 | * `MO()` momentary keys. See also [Layers](feature_layers.md). | ||
175 | * `LT()` layer tap keys, when held to activate a layer. However when tapped, and the key is quickly released, and sends a keycode, haptic feedback is still triggered. | ||
176 | * `TT()` layer tap toggle keys, when held to activate a layer. However when tapped `TAPPING_TOGGLE` times to permanently toggle the layer, on the last tap haptic feedback is still triggered. | ||
177 | * `MT()` mod tap keys, when held to keep a usual modifier key pressed. However when tapped, and the key is quickly released, and sends a keycode, haptic feedback is still triggered. See also [Mod-Tap](mod_tap.md). | ||
172 | 178 | ||
173 | ### NO_HAPTIC_FN | 179 | ### NO_HAPTIC_FN |
174 | With the entry of `#define NO_HAPTIC_FN` in config.h, layer keys will not rigger a feedback. | 180 | With the entry of `#define NO_HAPTIC_FN` in config.h, deprecated `fn_actions` type function keys will not trigger a feedback. |
175 | 181 | ||
176 | ### NO_HAPTIC_ALPHA | 182 | ### NO_HAPTIC_ALPHA |
177 | With the entry of `#define NO_HAPTIC_ALPHA` in config.h, none of the alpha keys (A ... Z) will trigger a feedback. | 183 | With the entry of `#define NO_HAPTIC_ALPHA` in config.h, none of the alpha keys (A ... Z) will trigger a feedback. |