aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Custom-Quantum-Functions.md
diff options
context:
space:
mode:
authorJack Humbert <jack.humb@gmail.com>2017-06-10 12:27:05 -0400
committerGitHub <noreply@github.com>2017-06-10 12:27:05 -0400
commit2508b9b6e23d9569569ff0c99b83f1a81bc66f45 (patch)
tree00c0ba26b4e068e810ba4ad52b7569d01607c81b /docs/Custom-Quantum-Functions.md
parent1da0a19177effe3a946a5188c692fa8749a3a4f1 (diff)
parent43b6179febfd25d6d9ce672c7303edff26f3c300 (diff)
downloadfirmware-2508b9b6e23d9569569ff0c99b83f1a81bc66f45.tar.gz
firmware-2508b9b6e23d9569569ff0c99b83f1a81bc66f45.tar.bz2
firmware-2508b9b6e23d9569569ff0c99b83f1a81bc66f45.zip
Merge pull request #1380 from qmk/improve_macro_docs
Clean up and improve the macro documentation
Diffstat (limited to 'docs/Custom-Quantum-Functions.md')
-rw-r--r--docs/Custom-Quantum-Functions.md20
1 files changed, 10 insertions, 10 deletions
diff --git a/docs/Custom-Quantum-Functions.md b/docs/Custom-Quantum-Functions.md
index 1c4929e5a..0fb1c163b 100644
--- a/docs/Custom-Quantum-Functions.md
+++ b/docs/Custom-Quantum-Functions.md
@@ -4,7 +4,7 @@ A custom keyboard is about more than sending button presses to your computer. QM
We have structured QMK as a hierarchy:
-* Core
+* Core (`_quantum`)
* Keyboard/Revision (`_kb`)
* Keymap (`_user`)
@@ -64,14 +64,14 @@ The `record` variable contains infomation about the actual press:
```
keyrecord_t record {
- keyevent_t event {
- keypos_t key {
- uint8_t col
- uint8_t row
- }
- bool pressed
- uint16_t time
- }
++-keyevent_t event {
+| +-keypos_t key {
+| | +-uint8_t col
+| | +-uint8_t row
+| | }
+| +-bool pressed
+| +-uint16_t time
+| }
}
```
@@ -120,4 +120,4 @@ void led_set_kb(uint8_t usb_led) {
PORTB &= ~(1<<4);
}
}
-``` \ No newline at end of file
+```