From dc22b0593f3b5e28bd17f705b9fbd2edca6bc1c6 Mon Sep 17 00:00:00 2001 From: mbanth Date: Tue, 30 Nov 2021 15:04:33 +0000 Subject: [PATCH] Additional documentation --- lib_xua/src/core/user/hid/user_hid.h | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/lib_xua/src/core/user/hid/user_hid.h b/lib_xua/src/core/user/hid/user_hid.h index af826971..bde24691 100644 --- a/lib_xua/src/core/user/hid/user_hid.h +++ b/lib_xua/src/core/user/hid/user_hid.h @@ -79,7 +79,8 @@ size_t UserHIDRecordEvent( const hidEvent_t hidEvent[], const size_t hidEventCnt /** * \brief Indicate if a HID Report ID has new data to report * - * \param[in] id A HID Report ID (see 5.6, 6.2.2.7, 8.1 and 8.2) + * \param[in] id A HID Report ID (see 5.6, 6.2.2.7, 8.1 and 8.2). + * A value of zero means the application does not use Report IDs. * * \returns A Boolean flag indicating the status of the operation * \retval False The given \a id either does not have new data to report or lies