diff mbox series

input: Correct kernel-doc inconsistency

Message ID 20200719201312.148814-1-colton.w.lewis@protonmail.com (mailing list archive)
State New, archived
Headers show
Series input: Correct kernel-doc inconsistency | expand

Commit Message

Colton Lewis July 19, 2020, 8:13 p.m. UTC 
Silence documentation build warnings by correcting kernel-doc comment
for key_entry struct.

./include/linux/input/sparse-keymap.h:43: warning: Function parameter or member 'sw' not described in 'key_entry'

Signed-off-by: Colton Lewis <colton.w.lewis@protonmail.com>
---
 include/linux/input/sparse-keymap.h | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
diff mbox series

Patch

diff --git a/include/linux/input/sparse-keymap.h b/include/linux/input/sparse-keymap.h
index d25d1452dc6e..119f4b275fc6 100644
--- a/include/linux/input/sparse-keymap.h
+++ b/include/linux/input/sparse-keymap.h
@@ -20,8 +20,9 @@ 
  *	private definitions.
  * @code: Device-specific data identifying the button/switch
  * @keycode: KEY_* code assigned to a key/button
- * @sw.code: SW_* code assigned to a switch
- * @sw.value: Value that should be sent in an input even when KE_SW
+ * @sw: struct breaking keycode into code and value
+ *	.code: SW_* code assigned to a switch
+ *	.value: Value that should be sent in an input even when KE_SW
  *	switch is toggled. KE_VSW switches ignore this field and
  *	expect driver to supply value for the event.
  *