]> git.donarmstrong.com Git - qmk_firmware.git/commitdiff
Docs: Clarify audio keycodes (#4620)
authorDrashna Jaelre <drashna@live.com>
Fri, 14 Dec 2018 18:43:24 +0000 (10:43 -0800)
committerMechMerlin <30334081+mechmerlin@users.noreply.github.com>
Fri, 14 Dec 2018 18:43:24 +0000 (10:43 -0800)
* 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

docs/feature_audio.md
docs/keycodes.md

index a39c456873f32a04a55c3cca19cf551bcd29dfd8..38861e8c14dffafb019a95ea1bc06e81a90117df 100644 (file)
@@ -61,9 +61,11 @@ It's advised that you wrap all audio features in `#ifdef AUDIO_ENABLE` / `#endif
 
 The available keycodes for audio are: 
 
-* `AU_ON` - Turn audio mode on
-* `AU_OFF` - Turn audio mode off
-* `AU_TOG` - Toggle audio mode
+* `AU_ON` - Turn Audio Feature on
+* `AU_OFF` - Turn Audio Feature off
+* `AU_TOG` - Toggle Audio Feature state
+
+!> 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. 
 
 ## ARM Audio Volume
 
@@ -158,7 +160,7 @@ You can configure the default, min and max frequencies, the stepping and built i
 
 ## MIDI Functionality
 
-This is still a WIP, but check out `quantum/keymap_midi.c` to see what's happening. Enable from the Makefile.
+This is still a WIP, but check out `quantum/process_keycode/process_midi.c` to see what's happening. Enable from the Makefile.
 
 
 ## Audio Keycodes
index 468b59f84fc18a5447dcf4278056a216435c0cdb..6d85253935f2a15a399c2dc46a9da81e5e0f2a01 100644 (file)
@@ -226,9 +226,9 @@ This is a reference only. Each group of keys links to the page documenting their
 
 |Key             |Aliases  |Description                       |
 |----------------|---------|----------------------------------|
-|`AU_ON`         |         |Audio mode on                     |
-|`AU_OFF`        |         |Audio mode off                    |
-|`AU_TOG`        |         |Toggles Audio mode                |
+|`AU_ON`         |         |Turns on Audio Feature            |
+|`AU_OFF`        |         |Turns off Audio Feature           |
+|`AU_TOG`        |         |Toggles Audio state               |
 |`CLICKY_TOGGLE` |`CK_TOGG`|Toggles Audio clicky mode         |
 |`CLICKY_UP`     |`CK_UP`  |Increases frequency of the clicks |
 |`CLICKY_DOWN`   |`CK_DOWN`|Decreases frequency of the clicks |