diff options
author | Joel Challis <[email protected]> | 2024-06-22 09:10:58 +0100 |
---|---|---|
committer | GitHub <[email protected]> | 2024-06-22 09:10:58 +0100 |
commit | cb39df273de782be1145dc5184bfd47d823531d5 (patch) | |
tree | 486d97664196d69a31617dcdbe21df261d3a6f1e /docs | |
parent | 99aa4f5191ae0e120503385869b3b24baeaf223a (diff) | |
download | qmk_firmware-cb39df273de782be1145dc5184bfd47d823531d5.tar.gz qmk_firmware-cb39df273de782be1145dc5184bfd47d823531d5.zip |
Remove deprecated `led_set_user` (#23979)
Diffstat (limited to 'docs')
-rw-r--r-- | docs/features/led_indicators.md | 7 |
1 files changed, 1 insertions, 6 deletions
diff --git a/docs/features/led_indicators.md b/docs/features/led_indicators.md index 8435c69a55..211fda2581 100644 --- a/docs/features/led_indicators.md +++ b/docs/features/led_indicators.md @@ -21,9 +21,8 @@ There are three ways to get the lock LED state: The `host_keyboard_led_state()` may reflect an updated state before `led_update_user()` is called. ::: -Two deprecated functions that provide the LED state as `uint8_t`: +Deprecated functions that provide the LED state as `uint8_t`: -* `uint8_t led_set_user(uint8_t usb_led)` * `uint8_t host_keyboard_leds()` ## Configuration Options @@ -50,10 +49,6 @@ When the configuration options do not provide enough flexibility, the following Both receives LED state as a struct parameter. Returning `true` in `led_update_user()` will allow the keyboard level code in `led_update_kb()` to run as well. Returning `false` will override the keyboard level code, depending on how the keyboard level function is set up. -::: tip -This boolean return type of `led_update_user` allows for overriding keyboard LED controls, and is thus recommended over the void `led_set_user` function. -::: - ### Example of keyboard LED update implementation This is a template indicator function that can be implemented on keyboard level code: |