From eab2a22b2f5f3d4540de00d8100d8d6c9a4c9473 Mon Sep 17 00:00:00 2001 From: waffle87 <0x6a73@protonmail.com> Date: Mon, 13 Mar 2023 19:35:52 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20qmk/qmk?= =?UTF-8?q?=5Ffirmware@a71e58270c4e2e8c88fe997405cbcb48bb864479=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- feature_autocorrect.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/feature_autocorrect.md b/feature_autocorrect.md index aa8d37817d0..9f80c93f827 100644 --- a/feature_autocorrect.md +++ b/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.