scottk/UltraGrid
1
0
Fork 0
mirror of https://github.com/outbackdingo/UltraGrid.git synced 2026-04-05 02:05:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

keycontrol_send_key(): improved doxy documentation

Browse Source
This commit is contained in:
Martin Pulec
2021-08-02 14:59:25 +02:00
parent 1fba84828a
commit 2865ea8a4c
1 changed files with 2 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
src/keyboard_control.cpp
View File

@@ -893,7 +893,8 @@ void keycontrol_send_key(struct module *root, int64_t key) {
*
* @ref message_universal message type is always sent
* @param[in] sender_mod module that should receive the message for key
* @param[in] description optional decription (may be NULL)
* @param[in] message text that will be passed back to receiver_mod if key was pressed
* @param[in] description optional decription that will be displayed in keyboard control help (may be NULL)
*/
bool keycontrol_register_key(struct module *receiver_mod, int64_t key, const char *message, const char *description) {
assert(strchr(message, '#') == nullptr && strchr(description, '#') == nullptr);