Skip to content

Commit fdd9046

Browse files
filterpaperrodrigob
authored andcommitted
Document Autocorrect callback functions (qmk#20115)
1 parent 55db4d9 commit fdd9046

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

docs/feature_autocorrect.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -236,6 +236,18 @@ bool apply_autocorrect(uint8_t backspaces, const char *str) {
236236
}
237237
```
238238

239+
### Autocorrect Status
240+
241+
Additional user callback functions to manipulate Autocorrect:
242+
243+
| Function | Description |
244+
|----------------------------|----------------------------------------------|
245+
| `autocorrect_enable()` | Turns Autocorrect on. |
246+
| `autocorrect_disable()` | Turns Autocorrect off. |
247+
| `autocorrect_toggle()` | Toggles Autocorrect. |
248+
| `autocorrect_is_enabled()` | Returns true if Autocorrect is currently on. |
249+
250+
239251
## Appendix: Trie binary data format :id=appendix
240252

241253
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.

0 commit comments

Comments
 (0)