diff options
| author | Nikolaus Wittenstein <nikolaus.wittenstein@gmail.com> | 2019-01-16 13:57:48 -0500 |
|---|---|---|
| committer | Drashna Jaelre <drashna@live.com> | 2019-01-16 10:57:48 -0800 |
| commit | 2fd86f4252de4d04c34e1f2ea2ba1da4b842cdd5 (patch) | |
| tree | 334063e528a2e3cd5e3646cfbab01585322e7ecc /tmk_core/common | |
| parent | 6630e4bb4156ec41f2a255dea4937f578cc62e06 (diff) | |
Add some function comments in action_layer.c (#4858)
Diffstat (limited to 'tmk_core/common')
| -rw-r--r-- | tmk_core/common/action_layer.c | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/tmk_core/common/action_layer.c b/tmk_core/common/action_layer.c index 120ce3f51b..3147d61b36 100644 --- a/tmk_core/common/action_layer.c +++ b/tmk_core/common/action_layer.c @@ -140,7 +140,7 @@ void layer_state_set(uint32_t state) /** \brief Layer clear * - * FIXME: Needs docs + * Turn off all layers. */ void layer_clear(void) { @@ -149,7 +149,7 @@ void layer_clear(void) /** \brief Layer state is * - * FIXME: Needs docs + * Return whether the given state is on (it might still be shadowed by a higher state, though). */ bool layer_state_is(uint8_t layer) { @@ -167,7 +167,7 @@ bool layer_state_cmp(uint32_t cmp_layer_state, uint8_t layer) { /** \brief Layer move * - * FIXME: Needs docs + * Turn on the given layer and turn off all other layers. */ void layer_move(uint8_t layer) { @@ -176,7 +176,7 @@ void layer_move(uint8_t layer) /** \brief Layer on * - * FIXME: Needs docs + * Turn on the given layer. */ void layer_on(uint8_t layer) { @@ -194,7 +194,7 @@ void layer_off(uint8_t layer) /** \brief Layer invert * - * FIXME: Needs docs + * Toggle the given layer (set it if it's unset, or unset it if it's set). */ void layer_invert(uint8_t layer) { @@ -228,7 +228,7 @@ void layer_xor(uint32_t state) /** \brief Layer debug printing * - * FIXME: Needs docs + * Print out the hex value of the 32-bit layer state, as well as the value of the highest bit. */ void layer_debug(void) { |