Merge pull request #7065 from keymanapp/fix/core/kbptypo

docs(core): cleanup in keyboardprocessor.h
This commit is contained in:
Steven R. Loomis 2022-08-12 09:40:11 -05:00 committed by GitHub
commit 431d3b0a4a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -650,7 +650,7 @@ undefined. The returned buffer uses UTF-8 encoding.
- `KM_KBP_STATUS_INVALID_ARGUMENT`: If non-optional parameters are null.
- `KM_KBP_STATUS_NO_MEM`: In the event an internal memory allocation fails.
##### Parameters:
- __opts__: An opaque pointer to a state object.
- __state__: An opaque pointer to a state object.
- __buf__: A pointer to the buffer to place the C string containing the JSON
document into, can be null.
- __space__: A pointer to a size_t variable. This variable must contain the
@ -793,7 +793,7 @@ km_kbp_keyboard_get_key_list(km_kbp_keyboard const *keyboard,
Free the allocated memory belonging to a keyboard key list previously
returned by `km_kbp_keyboard_get_key_list`.
##### Parameters:
- __keyboard__: A pointer to the keyboard key list to be
- __key_list__: A pointer to the keyboard key list to be
disposed of.
```c
@ -1118,10 +1118,6 @@ In the event the `state` pointer is null
##### Parameters:
- __state__: A pointer to the opaque state object.
- __vk__: A virtual key to be processed.
- __modifier_state__:
The combinations of modifier keys set at the time key `vk` was pressed, bitmask
from the `km_kbp_modifier_state` enum.
```c
*/