diff options
Diffstat (limited to 'docs/custom_quantum_functions.md')
-rw-r--r-- | docs/custom_quantum_functions.md | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/custom_quantum_functions.md b/docs/custom_quantum_functions.md index 16faf9732..928dccc9c 100644 --- a/docs/custom_quantum_functions.md +++ b/docs/custom_quantum_functions.md | |||
@@ -1,6 +1,6 @@ | |||
1 | # How to Customize Your Keyboard's Behavior | 1 | # How to Customize Your Keyboard's Behavior |
2 | 2 | ||
3 | For a lot of people a custom keyboard is about more than sending button presses to your computer. You want to be able to do things that are more complex than simple button presses and macros. QMK has hooks that allow you to inject code, override functionality, and otherwise customize how your keyboard behaves in different situations. | 3 | For a lot of people a custom keyboard is about more than sending button presses to your computer. You want to be able to do things that are more complex than simple button presses and macros. QMK has hooks that allow you to inject code, override functionality, and otherwise customize how your keyboard behaves in different situations. |
4 | 4 | ||
5 | This page does not assume any special knowledge about QMK, but reading [Understanding QMK](understanding_qmk.md) will help you understand what is going on at a more fundamental level. | 5 | This page does not assume any special knowledge about QMK, but reading [Understanding QMK](understanding_qmk.md) will help you understand what is going on at a more fundamental level. |
6 | 6 | ||
@@ -66,7 +66,7 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) { | |||
66 | 66 | ||
67 | ### `process_record_*` Function Documentation | 67 | ### `process_record_*` Function Documentation |
68 | 68 | ||
69 | * Keyboard/Revision: `bool process_record_kb(uint16_t keycode, keyrecord_t *record)` | 69 | * Keyboard/Revision: `bool process_record_kb(uint16_t keycode, keyrecord_t *record)` |
70 | * Keymap: `bool process_record_user(uint16_t keycode, keyrecord_t *record)` | 70 | * Keymap: `bool process_record_user(uint16_t keycode, keyrecord_t *record)` |
71 | 71 | ||
72 | The `keycode` argument is whatever is defined in your keymap, eg `MO(1)`, `KC_L`, etc. You should use a `switch...case` block to handle these events. | 72 | The `keycode` argument is whatever is defined in your keymap, eg `MO(1)`, `KC_L`, etc. You should use a `switch...case` block to handle these events. |
@@ -130,7 +130,7 @@ void led_set_kb(uint8_t usb_led) { | |||
130 | 130 | ||
131 | ### `led_set_*` Function Documentation | 131 | ### `led_set_*` Function Documentation |
132 | 132 | ||
133 | * Keyboard/Revision: `void led_set_kb(uint8_t usb_led)` | 133 | * Keyboard/Revision: `void led_set_kb(uint8_t usb_led)` |
134 | * Keymap: `void led_set_user(uint8_t usb_led)` | 134 | * Keymap: `void led_set_user(uint8_t usb_led)` |
135 | 135 | ||
136 | # Matrix Initialization Code | 136 | # Matrix Initialization Code |
@@ -155,7 +155,7 @@ void matrix_init_kb(void) { | |||
155 | 155 | ||
156 | ### `matrix_init_*` Function Documentation | 156 | ### `matrix_init_*` Function Documentation |
157 | 157 | ||
158 | * Keyboard/Revision: `void matrix_init_kb(void)` | 158 | * Keyboard/Revision: `void matrix_init_kb(void)` |
159 | * Keymap: `void matrix_init_user(void)` | 159 | * Keymap: `void matrix_init_user(void)` |
160 | 160 | ||
161 | # Matrix Scanning Code | 161 | # Matrix Scanning Code |