HID: core: Improve the kerneldoc for hid_report_len()
authorAlan Stern <stern@rowland.harvard.edu>
Sun, 13 Jul 2025 15:36:12 +0000 (11:36 -0400)
committerBenjamin Tissoires <bentiss@kernel.org>
Tue, 15 Jul 2025 15:28:27 +0000 (17:28 +0200)
commit12f33ef6c2aaa410b7ccf039289fe2b04ab2252f
treeb025bb6e54db0b296415b203bb59ed078dd9f702
parent4051ead99888f101be92c7ce90d2de09aac6fd1c
HID: core: Improve the kerneldoc for hid_report_len()

The kerneldoc for hid_report_len() needs to be improved.  The
description of the @report argument is ungrammatical, and the
documentation does not explain under what circumstances the report
length will include the byte reserved for the report ID.

Let's fix up the kerneldoc.

Signed-off-by: Alan Stern <stern@rowland.harvard.edu>
Link: https://patch.msgid.link/1c8416cb-7347-4a06-b00a-20518069d263@rowland.harvard.edu
Signed-off-by: Benjamin Tissoires <bentiss@kernel.org>
include/linux/hid.h