diff options
| author | Albert Y <76888457+filterpaper@users.noreply.github.com> | 2022-08-13 08:27:24 +0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-08-12 17:27:24 -0700 |
| commit | 70c6b183dfa9f08b8bf0d11be2cd5036ebed9ff4 (patch) | |
| tree | 77e499bdf7f9133819ded5ceea53b1a07e215301 /docs | |
| parent | 1a4a2782519a94a5c418ab7e8800c45b3e4d60cf (diff) | |
| download | qmk_firmware-70c6b183dfa9f08b8bf0d11be2cd5036ebed9ff4.tar.gz qmk_firmware-70c6b183dfa9f08b8bf0d11be2cd5036ebed9ff4.zip | |
[Docs] Refactor code examples (#18003)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/feature_encoders.md | 55 | ||||
| -rw-r--r-- | docs/feature_rgb_matrix.md | 8 | ||||
| -rw-r--r-- | docs/newbs_learn_more_resources.md | 1 |
3 files changed, 33 insertions, 31 deletions
diff --git a/docs/feature_encoders.md b/docs/feature_encoders.md index ad6ed2bece..fdde03ac23 100644 --- a/docs/feature_encoders.md +++ b/docs/feature_encoders.md @@ -125,34 +125,37 @@ Layer conditions can also be used with the callback function like the following: ```c bool encoder_update_user(uint8_t index, bool clockwise) { - if (get_highest_layer(layer_state|default_layer_state) > 0) { - if (index == 0) { - if (clockwise) { - tap_code(KC_WH_D); - } else { - tap_code(KC_WH_U); + switch(get_highest_layer(layer_state|default_layer_state)) { + case 0: + if (index == 0) { + if (clockwise) { + tap_code(KC_PGDN); + } else { + tap_code(KC_PGUP); + } + } else if (index == 1) { + if (clockwise) { + rgb_matrix_increase_speed(); + } else { + rgb_matrix_decrease_speed(); + } } - } else if (index == 1) { - if (clockwise) { - tap_code_delay(KC_VOLU, 10); - } else { - tap_code_delay(KC_VOLD, 10); + break; + case 1: + if (index == 0) { + if (clockwise) { + tap_code(KC_WH_D); + } else { + tap_code(KC_WH_U); + } + } else if (index == 1) { + if (clockwise) { + tap_code_delay(KC_VOLU, 10); + } else { + tap_code_delay(KC_VOLD, 10); + } } - } - } else { /* Layer 0 */ - if (index == 0) { - if (clockwise) { - tap_code(KC_PGDN); - } else { - tap_code(KC_PGUP); - } - } else if (index == 1) { - if (clockwise) { - rgb_matrix_increase_speed(); - } else { - rgb_matrix_decrease_speed(); - } - } + break; } return false; } diff --git a/docs/feature_rgb_matrix.md b/docs/feature_rgb_matrix.md index b664ccd698..5cdb4dac08 100644 --- a/docs/feature_rgb_matrix.md +++ b/docs/feature_rgb_matrix.md @@ -889,15 +889,15 @@ void rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) { } ``` -Layer indicator on all flagged keys: +Layer indicator on all keys: ```c void rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) { for (uint8_t i = led_min; i <= led_max; i++) { switch(get_highest_layer(layer_state|default_layer_state)) { - case RAISE: + case 2: rgb_matrix_set_color(i, RGB_BLUE); break; - case LOWER: + case 1: rgb_matrix_set_color(i, RGB_YELLOW); break; default: @@ -907,7 +907,7 @@ void rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) { } ``` -Layer indicator with only configured keys: +Layer indicator only on keys with configured keycodes: ```c void rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) { if (get_highest_layer(layer_state) > 0) { diff --git a/docs/newbs_learn_more_resources.md b/docs/newbs_learn_more_resources.md index a66ee4ab26..1afdc206bd 100644 --- a/docs/newbs_learn_more_resources.md +++ b/docs/newbs_learn_more_resources.md @@ -20,7 +20,6 @@ Not sure which text editor to use? Editors specifically made for code: * [Sublime Text](https://www.sublimetext.com/) * [VS Code](https://code.visualstudio.com/) -* [Atom](https://atom.io/) ### Git resources |