diff mbox series

[v2,1/2] Input: resistive-adc-touch - describe parameters in kernel doc

Message ID 20210528151113.85943-1-andriy.shevchenko@linux.intel.com (mailing list archive)
State Accepted
Commit 02e28cf7dc2b7acbe660188a87ac0b8007dde3dd
Headers show
Series [v2,1/2] Input: resistive-adc-touch - describe parameters in kernel doc | expand

Commit Message

Andy Shevchenko May 28, 2021, 3:11 p.m. UTC
Validation script is not happy:

 resistive-adc-touch.c:53: warning: Function parameter or member 'x_plate_ohms' not described in 'grts_state'
 resistive-adc-touch.c:53: warning: Function parameter or member 'ch' not described in 'grts_state'

Describe parameters in kernel doc to make it happy.

Fixes: fb082cd59afa ("Input: resistive-adc-touch - add support for z1 and z2 channels")
Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
---
 drivers/input/touchscreen/resistive-adc-touch.c | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

Comments

Dmitry Torokhov June 1, 2021, 5:53 a.m. UTC | #1
On Fri, May 28, 2021 at 06:11:12PM +0300, Andy Shevchenko wrote:
> Validation script is not happy:
> 
>  resistive-adc-touch.c:53: warning: Function parameter or member 'x_plate_ohms' not described in 'grts_state'
>  resistive-adc-touch.c:53: warning: Function parameter or member 'ch' not described in 'grts_state'
> 
> Describe parameters in kernel doc to make it happy.
> 
> Fixes: fb082cd59afa ("Input: resistive-adc-touch - add support for z1 and z2 channels")
> Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>

Applied, thank you.
diff mbox series

Patch

diff --git a/drivers/input/touchscreen/resistive-adc-touch.c b/drivers/input/touchscreen/resistive-adc-touch.c
index 0939c0e97efb..0353400c559a 100644
--- a/drivers/input/touchscreen/resistive-adc-touch.c
+++ b/drivers/input/touchscreen/resistive-adc-touch.c
@@ -35,16 +35,18 @@  enum grts_ch_type {
 
 /**
  * struct grts_state - generic resistive touch screen information struct
+ * @x_plate_ohms:	resistance of the X plate
  * @pressure_min:	number representing the minimum for the pressure
  * @pressure:		are we getting pressure info or not
  * @iio_chans:		list of channels acquired
  * @iio_cb:		iio_callback buffer for the data
  * @input:		the input device structure that we register
  * @prop:		touchscreen properties struct
+ * @ch:			channels that are defined for the touchscreen
  */
 struct grts_state {
-	u32				pressure_min;
 	u32				x_plate_ohms;
+	u32				pressure_min;
 	bool				pressure;
 	struct iio_channel		*iio_chans;
 	struct iio_cb_buffer		*iio_cb;