[PATCH] iio: st_sensors: correct kernel-doc issues

[PATCH] iio: st_sensors: correct kernel-doc issues

[Randy Dunlap]

Use the proper kernel-doc format and struct member names to avoid
kernel-doc warnings:

Warning: include/linux/iio/common/st_sensors.h:184 struct member 'int1'
 not described in 'st_sensor_data_ready_irq'
Warning: ../include/linux/iio/common/st_sensors.h:184 struct member 'int2'
 not described in 'st_sensor_data_ready_irq'
Warning: ../include/linux/iio/common/st_sensors.h:184 struct member
 'stat_drdy' not described in 'st_sensor_data_ready_irq'
Warning: ../include/linux/iio/common/st_sensors.h:184 struct member 'ig1'
 not described in 'st_sensor_data_ready_irq'
Warning: ../include/linux/iio/common/st_sensors.h:219 struct member
 'num_ch' not described in 'st_sensor_settings'
Warning: ../include/linux/iio/common/st_sensors.h:263 struct member
 'num_data_channels' not described in 'st_sensor_data'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
 include/linux/iio/common/st_sensors.h |   11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)

Cc: Jonathan Cameron <jic23@kernel.org>
Cc: David Lechner <dlechner@baylibre.com>
Cc: Nuno Sá <nuno.sa@analog.com>
Cc: Andy Shevchenko <andy@kernel.org>
Cc: linux-iio@vger.kernel.org

--- linux-next-20260311.orig/include/linux/iio/common/st_sensors.h
+++ linux-next-20260311/include/linux/iio/common/st_sensors.h
@@ -160,12 +160,12 @@ struct st_sensor_int_drdy {
 
 /**
  * struct st_sensor_data_ready_irq - ST sensor device data-ready interrupt
- * struct int1 - data-ready configuration register for INT1 pin.
- * struct int2 - data-ready configuration register for INT2 pin.
+ * @int1: data-ready configuration register for INT1 pin.
+ * @int2: data-ready configuration register for INT2 pin.
  * @addr_ihl: address to enable/disable active low on the INT lines.
  * @mask_ihl: mask to enable/disable active low on the INT lines.
- * struct stat_drdy - status register of DRDY (data ready) interrupt.
- * struct ig1 - represents the Interrupt Generator 1 of sensors.
+ * @stat_drdy: status register of DRDY (data ready) interrupt.
+ * @ig1: represents the Interrupt Generator 1 of sensors.
  * @en_addr: address of the enable ig1 register.
  * @en_mask: mask to write the on/off value for enable.
  */
@@ -190,6 +190,7 @@ struct st_sensor_data_ready_irq {
  * @wai_addr: The address of WhoAmI register.
  * @sensors_supported: List of supported sensors by struct itself.
  * @ch: IIO channels for the sensor.
+ * @num_ch: Number of IIO channels in @ch
  * @odr: Output data rate register and ODR list available.
  * @pw: Power register of the sensor.
  * @enable_axis: Enable one or more axis of the sensor.
@@ -228,7 +229,7 @@ struct st_sensor_settings {
  * @regmap: Pointer to specific sensor regmap configuration.
  * @enabled: Status of the sensor (false->off, true->on).
  * @odr: Output data rate of the sensor [Hz].
- * num_data_channels: Number of data channels used in buffer.
+ * @num_data_channels: Number of data channels used in buffer.
  * @drdy_int_pin: Redirect DRDY on pin 1 (1) or pin 2 (2).
  * @int_pin_open_drain: Set the interrupt/DRDY to open drain.
  * @irq: the IRQ number.

Re: [PATCH] iio: st_sensors: correct kernel-doc issues

[Andy Shevchenko]

On Wed, Mar 11, 2026 at 10:13:45PM -0700, Randy Dunlap wrote:
> Use the proper kernel-doc format and struct member names to avoid
> kernel-doc warnings:
> 
> Warning: include/linux/iio/common/st_sensors.h:184 struct member 'int1'
>  not described in 'st_sensor_data_ready_irq'
> Warning: ../include/linux/iio/common/st_sensors.h:184 struct member 'int2'
>  not described in 'st_sensor_data_ready_irq'
> Warning: ../include/linux/iio/common/st_sensors.h:184 struct member
>  'stat_drdy' not described in 'st_sensor_data_ready_irq'
> Warning: ../include/linux/iio/common/st_sensors.h:184 struct member 'ig1'
>  not described in 'st_sensor_data_ready_irq'
> Warning: ../include/linux/iio/common/st_sensors.h:219 struct member
>  'num_ch' not described in 'st_sensor_settings'
> Warning: ../include/linux/iio/common/st_sensors.h:263 struct member
>  'num_data_channels' not described in 'st_sensor_data'

Thanks, it's a good patch for this driver!
Reviewed-by: Andy Shevchenko <andriy.shevchenko@intel.com>

-- 
With Best Regards,
Andy Shevchenko

Re: [PATCH] iio: st_sensors: correct kernel-doc issues

[Jonathan Cameron]

On Thu, 12 Mar 2026 12:33:43 +0200
Andy Shevchenko <andriy.shevchenko@intel.com> wrote:

> On Wed, Mar 11, 2026 at 10:13:45PM -0700, Randy Dunlap wrote:
> > Use the proper kernel-doc format and struct member names to avoid
> > kernel-doc warnings:
> > 
> > Warning: include/linux/iio/common/st_sensors.h:184 struct member 'int1'
> >  not described in 'st_sensor_data_ready_irq'
> > Warning: ../include/linux/iio/common/st_sensors.h:184 struct member 'int2'
> >  not described in 'st_sensor_data_ready_irq'
> > Warning: ../include/linux/iio/common/st_sensors.h:184 struct member
> >  'stat_drdy' not described in 'st_sensor_data_ready_irq'
> > Warning: ../include/linux/iio/common/st_sensors.h:184 struct member 'ig1'
> >  not described in 'st_sensor_data_ready_irq'
> > Warning: ../include/linux/iio/common/st_sensors.h:219 struct member
> >  'num_ch' not described in 'st_sensor_settings'
> > Warning: ../include/linux/iio/common/st_sensors.h:263 struct member
> >  'num_data_channels' not described in 'st_sensor_data'  
> 
> Thanks, it's a good patch for this driver!
> Reviewed-by: Andy Shevchenko <andriy.shevchenko@intel.com>
> 

Thanks for cleaning this up.

Applied to the testing branch of iio.git as various other things on there
need a poke from the bots before I push it out as togreg and linux-next
picks it up.

Thanks,

Jonathan