Input: resistive-adc-touch - describe parameters in kernel doc
authorAndy Shevchenko <andriy.shevchenko@linux.intel.com>
Mon, 31 May 2021 05:24:35 +0000 (22:24 -0700)
committerDmitry Torokhov <dmitry.torokhov@gmail.com>
Tue, 1 Jun 2021 05:52:31 +0000 (22:52 -0700)
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>
Link: https://lore.kernel.org/r/20210528151113.85943-1-andriy.shevchenko@linux.intel.com
Signed-off-by: Dmitry Torokhov <dmitry.torokhov@gmail.com>
drivers/input/touchscreen/resistive-adc-touch.c

index 0939c0e..0353400 100644 (file)
@@ -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;