Skip to content

Commit

Permalink
Document Autocorrect callback functions (#20115)
Browse files Browse the repository at this point in the history
  • Loading branch information
filterpaper authored Mar 13, 2023
1 parent e0bd6fa commit a71e582
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions docs/feature_autocorrect.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit a71e582

Please sign in to comment.