From 1d34f380eb2717169c59fb4eb59bb1824a1f7187 Mon Sep 17 00:00:00 2001 From: Ryan Date: Wed, 26 Oct 2022 00:45:57 +1100 Subject: Deprecate `KEY_OVERRIDE_*` keycodes for `KO_*` (#18843) --- docs/feature_key_overrides.md | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) (limited to 'docs') diff --git a/docs/feature_key_overrides.md b/docs/feature_key_overrides.md index 2417fcf594..36fd383cd4 100644 --- a/docs/feature_key_overrides.md +++ b/docs/feature_key_overrides.md @@ -150,15 +150,13 @@ const key_override_t fn_override = {.trigger_mods = MOD_BIT(KC_RGUI) | .enabled = NULL}; ``` -## Keycodes +## Keycodes -You can enable, disable and toggle all key overrides on the fly. - -|Keycode |Description |Function Equivalent| -|----------|---------------------------------|--------| -|`KEY_OVERRIDE_ON` |Turns on Key Override feature | `key_override_on(void)`| -|`KEY_OVERRIDE_OFF` |Turns off Key Override feature |`key_override_off(void)`| -|`KEY_OVERRIDE_TOGGLE` |Toggles Key Override feature on and off |`key_override_toggle(void)`| +|Keycode |Aliases |Description | +|------------------------|---------|----------------------| +|`QK_KEY_OVERRIDE_TOGGLE`|`KO_TOGG`|Toggle key overrides | +|`QK_KEY_OVERRIDE_ON` |`KO_ON` |Turn on key overrides | +|`QK_KEY_OVERRIDE_OFF` |`KO_OFF` |Turn off key overrides| ## Reference for `key_override_t` -- cgit v1.2.3