summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorQMK Bot <hello@qmk.fm>2023-03-13 19:35:24 +0000
committerQMK Bot <hello@qmk.fm>2023-03-13 19:35:24 +0000
commit5d92bab33eb32730a944ff992458fae6ef111338 (patch)
tree61d5a3797533d37928aee466b182484948211a43 /docs
parent91e0457b0ee8f1b7160d8f7591e0f60195db5455 (diff)
parenta71e58270c4e2e8c88fe997405cbcb48bb864479 (diff)
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'docs')
-rw-r--r--docs/feature_autocorrect.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/feature_autocorrect.md b/docs/feature_autocorrect.md
index aa8d37817d..9f80c93f82 100644
--- a/docs/feature_autocorrect.md
+++ b/docs/feature_autocorrect.md
@@ -236,6 +236,18 @@ bool apply_autocorrect(uint8_t backspaces, const char *str) {
}
```
+### Autocorrect Status
+
+Additional user callback functions to manipulate Autocorrect:
+
+| Function | Description |
+|----------------------------|----------------------------------------------|
+| `autocorrect_enable()` | Turns Autocorrect on. |
+| `autocorrect_disable()` | Turns Autocorrect off. |
+| `autocorrect_toggle()` | Toggles Autocorrect. |
+| `autocorrect_is_enabled()` | Returns true if Autocorrect is currently on. |
+
+
## Appendix: Trie binary data format :id=appendix
This section details how the trie is serialized to byte data in autocorrect_data. You don’t need to care about this to use this autocorrection implementation. But it is documented for the record in case anyone is interested in modifying the implementation, or just curious how it works.