~ruther/qmk_firmware

a71e58270c4e2e8c88fe997405cbcb48bb864479 — Albert Y 2 years ago e0bd6fa
Document Autocorrect callback functions (#20115)

1 files changed, 12 insertions(+), 0 deletions(-)

M docs/feature_autocorrect.md
M docs/feature_autocorrect.md => docs/feature_autocorrect.md +12 -0
@@ 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.