From 2865ea8a4c20365c558c81759878dc8d3285bc3f Mon Sep 17 00:00:00 2001 From: Martin Pulec Date: Mon, 2 Aug 2021 14:59:25 +0200 Subject: [PATCH] keycontrol_send_key(): improved doxy documentation --- src/keyboard_control.cpp | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/keyboard_control.cpp b/src/keyboard_control.cpp index b5bb81515..e7ace8df0 100644 --- a/src/keyboard_control.cpp +++ b/src/keyboard_control.cpp @@ -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);