diff options
| author | Drashna Jaelre <drashna@live.com> | 2018-12-14 10:43:24 -0800 |
|---|---|---|
| committer | MechMerlin <30334081+mechmerlin@users.noreply.github.com> | 2018-12-14 10:43:24 -0800 |
| commit | 9739d6ba0ad3da93f42cc28a78a6722d39ad3d72 (patch) | |
| tree | 765ea06ae341e64fa30ea594ab1d4f4f0d8e7c07 | |
| parent | 161ffa0af6b9af76b8e73a3f274bbc415ae9f842 (diff) | |
| download | qmk_firmware-9739d6ba0ad3da93f42cc28a78a6722d39ad3d72.tar.gz qmk_firmware-9739d6ba0ad3da93f42cc28a78a6722d39ad3d72.zip | |
Docs: Clarify audio keycodes (#4620)
* Clarify audio keycodes
* Spelling errors
Co-Authored-By: drashna <drashna@live.com>
* Spacing in md
Co-Authored-By: drashna <drashna@live.com>
* Fix midi link too
* Wordsmithing
| -rw-r--r-- | docs/feature_audio.md | 10 | ||||
| -rw-r--r-- | docs/keycodes.md | 6 |
2 files changed, 9 insertions, 7 deletions
diff --git a/docs/feature_audio.md b/docs/feature_audio.md index a39c45687..38861e8c1 100644 --- a/docs/feature_audio.md +++ b/docs/feature_audio.md | |||
| @@ -61,9 +61,11 @@ It's advised that you wrap all audio features in `#ifdef AUDIO_ENABLE` / `#endif | |||
| 61 | 61 | ||
| 62 | The available keycodes for audio are: | 62 | The available keycodes for audio are: |
| 63 | 63 | ||
| 64 | * `AU_ON` - Turn audio mode on | 64 | * `AU_ON` - Turn Audio Feature on |
| 65 | * `AU_OFF` - Turn audio mode off | 65 | * `AU_OFF` - Turn Audio Feature off |
| 66 | * `AU_TOG` - Toggle audio mode | 66 | * `AU_TOG` - Toggle Audio Feature state |
| 67 | |||
| 68 | !> These keycodes turn all of the audio functionality on and off. Turning it off means that audio feedback, audio clicky, music mode, etc. are disabled, completely. | ||
| 67 | 69 | ||
| 68 | ## ARM Audio Volume | 70 | ## ARM Audio Volume |
| 69 | 71 | ||
| @@ -158,7 +160,7 @@ You can configure the default, min and max frequencies, the stepping and built i | |||
| 158 | 160 | ||
| 159 | ## MIDI Functionality | 161 | ## MIDI Functionality |
| 160 | 162 | ||
| 161 | This is still a WIP, but check out `quantum/keymap_midi.c` to see what's happening. Enable from the Makefile. | 163 | This is still a WIP, but check out `quantum/process_keycode/process_midi.c` to see what's happening. Enable from the Makefile. |
| 162 | 164 | ||
| 163 | 165 | ||
| 164 | ## Audio Keycodes | 166 | ## Audio Keycodes |
diff --git a/docs/keycodes.md b/docs/keycodes.md index 468b59f84..6d8525393 100644 --- a/docs/keycodes.md +++ b/docs/keycodes.md | |||
| @@ -226,9 +226,9 @@ This is a reference only. Each group of keys links to the page documenting their | |||
| 226 | 226 | ||
| 227 | |Key |Aliases |Description | | 227 | |Key |Aliases |Description | |
| 228 | |----------------|---------|----------------------------------| | 228 | |----------------|---------|----------------------------------| |
| 229 | |`AU_ON` | |Audio mode on | | 229 | |`AU_ON` | |Turns on Audio Feature | |
| 230 | |`AU_OFF` | |Audio mode off | | 230 | |`AU_OFF` | |Turns off Audio Feature | |
| 231 | |`AU_TOG` | |Toggles Audio mode | | 231 | |`AU_TOG` | |Toggles Audio state | |
| 232 | |`CLICKY_TOGGLE` |`CK_TOGG`|Toggles Audio clicky mode | | 232 | |`CLICKY_TOGGLE` |`CK_TOGG`|Toggles Audio clicky mode | |
| 233 | |`CLICKY_UP` |`CK_UP` |Increases frequency of the clicks | | 233 | |`CLICKY_UP` |`CK_UP` |Increases frequency of the clicks | |
| 234 | |`CLICKY_DOWN` |`CK_DOWN`|Decreases frequency of the clicks | | 234 | |`CLICKY_DOWN` |`CK_DOWN`|Decreases frequency of the clicks | |