From 2577f05cb3996c0dec3860ca24b4f24b278dd1a7 Mon Sep 17 00:00:00 2001 From: Nick Brassel Date: Tue, 13 Aug 2024 11:50:54 +1000 Subject: [PATCH] Update documentation for keys that are actually handled. --- docs/features/bluetooth.md | 10 +++++----- docs/keycodes.md | 10 +++++----- quantum/process_keycode/process_connection.c | 3 ++- 3 files changed, 12 insertions(+), 11 deletions(-) diff --git a/docs/features/bluetooth.md b/docs/features/bluetooth.md index 1dbf15f4e10..d3634498be4 100644 --- a/docs/features/bluetooth.md +++ b/docs/features/bluetooth.md @@ -39,8 +39,8 @@ BLUETOOTH_DRIVER = bluefruit_le # or rn42 This is used when multiple keyboard outputs can be selected. Currently this only allows for switching between USB and Bluetooth on keyboards that support both. -|Key |Aliases |Description | -|---------------------|---------|----------------------------------------------| -|`QK_OUTPUT_AUTO` |`OU_AUTO`|Automatically switch between USB and Bluetooth| -|`QK_OUTPUT_USB` |`OU_USB` |USB only | -|`QK_OUTPUT_BLUETOOTH`|`OU_BT` |Bluetooth only | +| Key | Aliases | Description | +|-----------------------|----------------------|------------------------------------------------| +| `QK_OUTPUT_NEXT` | `OU_NEXT`, `OU_AUTO` | Automatically switch between USB and Bluetooth | +| `QK_OUTPUT_USB` | `OU_USB` | USB only | +| `QK_OUTPUT_BLUETOOTH` | `OU_BT` | Bluetooth only | diff --git a/docs/keycodes.md b/docs/keycodes.md index 9038c2b6d73..9107ca5eb88 100644 --- a/docs/keycodes.md +++ b/docs/keycodes.md @@ -294,11 +294,11 @@ See also: [Backlighting](features/backlight) See also: [Bluetooth](features/bluetooth) -|Key |Aliases |Description | -|---------------------|---------|----------------------------------------------| -|`QK_OUTPUT_AUTO` |`OU_AUTO`|Automatically switch between USB and Bluetooth| -|`QK_OUTPUT_USB` |`OU_USB` |USB only | -|`QK_OUTPUT_BLUETOOTH`|`OU_BT` |Bluetooth only | +| Key | Aliases | Description | +|-----------------------|----------------------|------------------------------------------------| +| `QK_OUTPUT_NEXT` | `OU_NEXT`, `OU_AUTO` | Automatically switch between USB and Bluetooth | +| `QK_OUTPUT_USB` | `OU_USB` | USB only | +| `QK_OUTPUT_BLUETOOTH` | `OU_BT` | Bluetooth only | ## Caps Word {#caps-word} diff --git a/quantum/process_keycode/process_connection.c b/quantum/process_keycode/process_connection.c index c86f1eda5d4..ca2f76af809 100644 --- a/quantum/process_keycode/process_connection.c +++ b/quantum/process_keycode/process_connection.c @@ -7,7 +7,7 @@ bool process_connection(uint16_t keycode, keyrecord_t *record) { if (record->event.pressed) { switch (keycode) { case QK_OUTPUT_NEXT: - set_output(OUTPUT_AUTO); + set_output(OUTPUT_AUTO); // This should cycle through the outputs going forward. Ensure `docs/features/bluetooth.md` is updated when it does. return false; case QK_OUTPUT_USB: set_output(OUTPUT_USB); @@ -28,6 +28,7 @@ bool process_connection(uint16_t keycode, keyrecord_t *record) { case QK_BLUETOOTH_PROFILE4: case QK_BLUETOOTH_PROFILE5: // As-yet unimplemented. + // When implementation is done, ensure `docs/features/bluetooth.md` is updated accordingly. return false; } }