Merge pull request #65 from kpfleming/document-hid-key-none

Add note to discourage users from using HID_KEY_NONE.
This commit is contained in:
Hrvoje Čavrak 2024-03-15 13:47:48 +01:00 committed by GitHub
commit 5d6fcc4975
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 7 additions and 1 deletions

View File

@ -23,6 +23,12 @@
*
* defined as HID_KEY_<something>
*
* If you do not want to use a key for switching outputs, you may be tempted
* to select HID_KEY_NONE here; don't do that! That code appears in many HID
* messages and the result will be a non-functional keyboard. Instead, choose
* a key that is unlikely to ever appear on a keyboard that you will use.
* HID_KEY_F24 is probably a good choice as keyboards with 24 function keys
* are rare.
* */
#define HOTKEY_TOGGLE HID_KEY_CAPS_LOCK
@ -70,4 +76,4 @@
* */
#define SCREENSAVER_ENABLED 0
#define SCREENSAVER_TIME_SEC 240
#define SCREENSAVER_TIME_SEC 240