diff options
Diffstat (limited to 'tmk_core/common/action_layer.c')
| -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 120ce3f51..3147d61b3 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) | |||
| 140 | 140 | ||
| 141 | /** \brief Layer clear | 141 | /** \brief Layer clear |
| 142 | * | 142 | * |
| 143 | * FIXME: Needs docs | 143 | * Turn off all layers. |
| 144 | */ | 144 | */ |
| 145 | void layer_clear(void) | 145 | void layer_clear(void) |
| 146 | { | 146 | { |
| @@ -149,7 +149,7 @@ void layer_clear(void) | |||
| 149 | 149 | ||
| 150 | /** \brief Layer state is | 150 | /** \brief Layer state is |
| 151 | * | 151 | * |
| 152 | * FIXME: Needs docs | 152 | * Return whether the given state is on (it might still be shadowed by a higher state, though). |
| 153 | */ | 153 | */ |
| 154 | bool layer_state_is(uint8_t layer) | 154 | bool layer_state_is(uint8_t layer) |
| 155 | { | 155 | { |
| @@ -167,7 +167,7 @@ bool layer_state_cmp(uint32_t cmp_layer_state, uint8_t layer) { | |||
| 167 | 167 | ||
| 168 | /** \brief Layer move | 168 | /** \brief Layer move |
| 169 | * | 169 | * |
| 170 | * FIXME: Needs docs | 170 | * Turn on the given layer and turn off all other layers. |
| 171 | */ | 171 | */ |
| 172 | void layer_move(uint8_t layer) | 172 | void layer_move(uint8_t layer) |
| 173 | { | 173 | { |
| @@ -176,7 +176,7 @@ void layer_move(uint8_t layer) | |||
| 176 | 176 | ||
| 177 | /** \brief Layer on | 177 | /** \brief Layer on |
| 178 | * | 178 | * |
| 179 | * FIXME: Needs docs | 179 | * Turn on the given layer. |
| 180 | */ | 180 | */ |
| 181 | void layer_on(uint8_t layer) | 181 | void layer_on(uint8_t layer) |
| 182 | { | 182 | { |
| @@ -194,7 +194,7 @@ void layer_off(uint8_t layer) | |||
| 194 | 194 | ||
| 195 | /** \brief Layer invert | 195 | /** \brief Layer invert |
| 196 | * | 196 | * |
| 197 | * FIXME: Needs docs | 197 | * Toggle the given layer (set it if it's unset, or unset it if it's set). |
| 198 | */ | 198 | */ |
| 199 | void layer_invert(uint8_t layer) | 199 | void layer_invert(uint8_t layer) |
| 200 | { | 200 | { |
| @@ -228,7 +228,7 @@ void layer_xor(uint32_t state) | |||
| 228 | 228 | ||
| 229 | /** \brief Layer debug printing | 229 | /** \brief Layer debug printing |
| 230 | * | 230 | * |
| 231 | * FIXME: Needs docs | 231 | * Print out the hex value of the 32-bit layer state, as well as the value of the highest bit. |
| 232 | */ | 232 | */ |
| 233 | void layer_debug(void) | 233 | void layer_debug(void) |
| 234 | { | 234 | { |
