summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAlbert Y <76888457+filterpaper@users.noreply.github.com>2023-04-10 00:37:31 +0800
committerGitHub <noreply@github.com>2023-04-09 09:37:31 -0700
commitf5b74918837bacc5aaa98641428309380d591707 (patch)
tree54e452545a995599c9962515bd9838f78455fe45 /docs
parent5d6d9594212073ca52b80a1a949510187af47b13 (diff)
Add swap hands toggle functions (#20381)
Diffstat (limited to 'docs')
-rw-r--r--docs/feature_swap_hands.md11
1 files changed, 8 insertions, 3 deletions
diff --git a/docs/feature_swap_hands.md b/docs/feature_swap_hands.md
index 4d0d554093..e9c1d4b7ba 100644
--- a/docs/feature_swap_hands.md
+++ b/docs/feature_swap_hands.md
@@ -47,6 +47,11 @@ const uint8_t PROGMEM encoder_hand_swap_config[NUM_ENCODERS] = { 1, 0 };
### Functions :id=functions
-| Function | Description |
-|----------------------|---------------------------------------------|
-| `is_swap_hands_on()` | Returns true if Swap-Hands is currently on. |
+User callback functions to manipulate Swap-Hands:
+
+| Function | Description |
+|-----------------------|---------------------------------------------|
+| `swap_hands_on()` | Turns Swap-Hands on. |
+| `swap_hands_off()` | Turns Swap-Hands off. |
+| `swap_hands_toggle()` | Toggles Swap-Hands. |
+| `is_swap_hands_on()` | Returns true if Swap-Hands is currently on. |