aboutsummaryrefslogtreecommitdiff
path: root/quantum/process_keycode/process_layer_lock.h
diff options
context:
space:
mode:
Diffstat (limited to 'quantum/process_keycode/process_layer_lock.h')
-rw-r--r--quantum/process_keycode/process_layer_lock.h48
1 files changed, 0 insertions, 48 deletions
diff --git a/quantum/process_keycode/process_layer_lock.h b/quantum/process_keycode/process_layer_lock.h
index b54c0f6f10..6795110029 100644
--- a/quantum/process_keycode/process_layer_lock.h
+++ b/quantum/process_keycode/process_layer_lock.h
@@ -12,54 +12,6 @@
// See the License for the specific language governing permissions and
// limitations under the License.
-/**
- * @file layer_lock.h
- * @brief Layer Lock, a key to stay in the current layer.
- *
- * Overview
- * --------
- *
- * Layers are often accessed by holding a button, e.g. with a momentary layer
- * switch `MO(layer)` or layer tap `LT(layer, key)` key. But you may sometimes
- * want to "lock" or "toggle" the layer so that it stays on without having to
- * hold down a button. One way to do that is with a tap-toggle `TT` layer key,
- * but here is an alternative.
- *
- * This library implements a "Layer Lock key". When tapped, it "locks" the
- * highest layer to stay active, assuming the layer was activated by one of the
- * following keys:
- *
- * * `MO(layer)` momentary layer switch
- * * `LT(layer, key)` layer tap
- * * `OSL(layer)` one-shot layer
- * * `TT(layer)` layer tap toggle
- * * `LM(layer, mod)` layer-mod key (the layer is locked, but not the mods)
- *
- * Tapping the Layer Lock key again unlocks and turns off the layer.
- *
- * @note When a layer is "locked", other layer keys such as `TO(layer)` or
- * manually calling `layer_off(layer)` will override and unlock the layer.
- *
- * Configuration
- * -------------
- *
- * Optionally, a timeout may be defined so that Layer Lock disables
- * automatically if not keys are pressed for `LAYER_LOCK_IDLE_TIMEOUT`
- * milliseconds. Define `LAYER_LOCK_IDLE_TIMEOUT` in your config.h, for instance
- *
- * #define LAYER_LOCK_IDLE_TIMEOUT 60000 // Turn off after 60 seconds.
- *
- * and call `layer_lock_task()` from your `matrix_scan_user()` in keymap.c:
- *
- * void matrix_scan_user(void) {
- * layer_lock_task();
- * // Other tasks...
- * }
- *
- * For full documentation, see
- * <https://getreuer.info/posts/keyboards/layer-lock>
- */
-
#pragma once
#include <stdint.h>