* [PATCH] input: Correct kernel-doc inconsistency
@ 2020-07-19 20:13 Colton Lewis
0 siblings, 0 replies; only message in thread
From: Colton Lewis @ 2020-07-19 20:13 UTC (permalink / raw)
To: dmitry.torokhov; +Cc: linux-input, Colton Lewis
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 --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.
*
--
2.26.2
^ permalink raw reply related [flat|nested] only message in thread
only message in thread, other threads:[~2020-07-19 20:13 UTC | newest]
Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-07-19 20:13 [PATCH] input: Correct kernel-doc inconsistency Colton Lewis
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).