input: fix input-mt kernel-doc warning

Commit Message

Henrik Rydberg Nov. 7, 2012, 7:46 p.m. UTC

Hi Randy,

> From: Randy Dunlap <[e-mail]>
> 
> Fix new kernel-doc warning in input-mt.c:
> 
> Warning(drivers/input/input-mt.c:38): No description found for parameter 'flags'

Thanks for the patch. It seemed reasonable to expand the function
documentation a bit as well, hope you are alright with the patch
below, Dmitry, care to pick this up for 3.7? Otherwise I can carry it
for 3.8.

Thanks,
Henrik

---

From a96b3a67eefba05d7e6de3afa1b51d17728d45d3 Mon Sep 17 00:00:00 2001
From: Henrik Rydberg <[e-mail]>
Date: Wed, 7 Nov 2012 20:40:24 +0100
Subject: [PATCH] Input: MT - Document undocumented init argument

Fixes new kernel-doc warning in input-mt.c:

Warning(drivers/input/input-mt.c:38): No description found for parameter 'flags'

Reported-by: Randy Dunlap <[e-mail]>
Signed-off-by: Henrik Rydberg <[e-mail]>
---
 drivers/input/input-mt.c | 4 ++++
 1 file changed, 4 insertions(+)

Comments

Dmitry Torokhov Nov. 8, 2012, 5:04 p.m. UTC | #1

On Wed, Nov 07, 2012 at 08:46:17PM +0100, Henrik Rydberg wrote:
> Hi Randy,
> 
> > From: Randy Dunlap <[e-mail]>
> > 
> > Fix new kernel-doc warning in input-mt.c:
> > 
> > Warning(drivers/input/input-mt.c:38): No description found for parameter 'flags'
> 
> Thanks for the patch. It seemed reasonable to expand the function
> documentation a bit as well, hope you are alright with the patch
> below, Dmitry, care to pick this up for 3.7? Otherwise I can carry it
> for 3.8.

Randy, Henrik,

I'll try getting it in 3.7.

Thanks.

Patch

diff --git a/drivers/input/input-mt.c b/drivers/input/input-mt.c
index c0ec7d4..1abbc17 100644
--- a/drivers/input/input-mt.c
+++ b/drivers/input/input-mt.c
@@ -26,10 +26,14 @@  static void copy_abs(struct input_dev *dev, unsigned int dst, unsigned int src)
  * input_mt_init_slots() - initialize MT input slots
  * @dev: input device supporting MT events and finger tracking
  * @num_slots: number of slots used by the device
+ * @flags: mt tasks to handle in core
  *
  * This function allocates all necessary memory for MT slot handling
  * in the input device, prepares the ABS_MT_SLOT and
  * ABS_MT_TRACKING_ID events for use and sets up appropriate buffers.
+ * Depending on the flags set, it also performs pointer emulation and
+ * frame synchronization.
+ *
  * May be called repeatedly. Returns -EINVAL if attempting to
  * reinitialize with a different number of slots.
  */