aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorskullY <skullydazed@gmail.com>2017-06-30 10:11:54 -0700
committerskullY <skullydazed@gmail.com>2017-06-30 10:13:25 -0700
commitea8df568f23b79eba13ef9e914d8b1ce94688858 (patch)
tree06b886fccec0ce83c722d1c4b88068f9ef2fc4bd
parent486abde026a2e2d44a09477bbeb4ff122c104f1d (diff)
downloadqmk_firmware-ea8df568f23b79eba13ef9e914d8b1ce94688858.tar.gz
qmk_firmware-ea8df568f23b79eba13ef9e914d8b1ce94688858.zip
reduce the TOC scope
-rw-r--r--book.json2
-rw-r--r--docs/custom_quantum_functions.md8
2 files changed, 5 insertions, 5 deletions
diff --git a/book.json b/book.json
index b7c62b1dd..887d2a643 100644
--- a/book.json
+++ b/book.json
@@ -23,7 +23,7 @@
23 "url": "https://github.com/qmk/qmk_firmware" 23 "url": "https://github.com/qmk/qmk_firmware"
24 }, 24 },
25 "page-toc": { 25 "page-toc": {
26 "selector": ".markdown-section h1, .markdown-section h2, .markdown-section h3" 26 "selector": ".markdown-section h1, .markdown-section h2"
27 }, 27 },
28 "toolbar": { 28 "toolbar": {
29 "buttons": [ 29 "buttons": [
diff --git a/docs/custom_quantum_functions.md b/docs/custom_quantum_functions.md
index 17615d991..0d6def45b 100644
--- a/docs/custom_quantum_functions.md
+++ b/docs/custom_quantum_functions.md
@@ -86,7 +86,7 @@ keyrecord_t record {
86} 86}
87``` 87```
88 88
89## LED Control 89# LED Control
90 90
91This allows you to control the 5 LED's defined as part of the USB Keyboard spec. It will be called when the state of one of those 5 LEDs changes. 91This allows you to control the 5 LED's defined as part of the USB Keyboard spec. It will be called when the state of one of those 5 LEDs changes.
92 92
@@ -133,11 +133,11 @@ void led_set_kb(uint8_t usb_led) {
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
137 137
138Before a keyboard can be used the hardware must be initialized. QMK handles initialization of the keyboard matrix itself, but if you have other hardware like LED's or i&#xb2;c controllers you will need to set up that hardware before it can be used. 138Before a keyboard can be used the hardware must be initialized. QMK handles initialization of the keyboard matrix itself, but if you have other hardware like LED's or i&#xb2;c controllers you will need to set up that hardware before it can be used.
139 139
140#### Example `matrix_init_kb()` implementation 140### Example `matrix_init_kb()` implementation
141 141
142This example, at the keyboard level, sets up B1, B2, and B3 as LED pins. 142This example, at the keyboard level, sets up B1, B2, and B3 as LED pins.
143 143
@@ -158,7 +158,7 @@ void matrix_init_kb(void) {
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
162 162
163Whenever possible you should customize your keyboard by using `process_record_*()` and hooking into events that way, to ensure that your code does not have a negative performance impact on your keyboard. However, in rare cases it is necessary to hook into the matrix scanning. Be extremely careful with the performance of code in these functions, as it will be called at least 10 times per second. 163Whenever possible you should customize your keyboard by using `process_record_*()` and hooking into events that way, to ensure that your code does not have a negative performance impact on your keyboard. However, in rare cases it is necessary to hook into the matrix scanning. Be extremely careful with the performance of code in these functions, as it will be called at least 10 times per second.
164 164