tjh.dev / kernel
Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

iio: st_sensors: correct kernel-doc issues

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>
Reviewed-by: Andy Shevchenko <andriy.shevchenko@intel.com>
Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>

authored by

Randy Dunlap and committed by
Jonathan Cameron e8b83499 6849c635

+6 -5
+6 -5
include/linux/iio/common/st_sensors.h
··· 160 160 161 161 /** 162 162 * struct st_sensor_data_ready_irq - ST sensor device data-ready interrupt 163 - * struct int1 - data-ready configuration register for INT1 pin. 164 - * struct int2 - data-ready configuration register for INT2 pin. 163 + * @int1: data-ready configuration register for INT1 pin. 164 + * @int2: data-ready configuration register for INT2 pin. 165 165 * @addr_ihl: address to enable/disable active low on the INT lines. 166 166 * @mask_ihl: mask to enable/disable active low on the INT lines. 167 - * struct stat_drdy - status register of DRDY (data ready) interrupt. 168 - * struct ig1 - represents the Interrupt Generator 1 of sensors. 167 + * @stat_drdy: status register of DRDY (data ready) interrupt. 168 + * @ig1: represents the Interrupt Generator 1 of sensors. 169 169 * @en_addr: address of the enable ig1 register. 170 170 * @en_mask: mask to write the on/off value for enable. 171 171 */ ··· 190 190 * @wai_addr: The address of WhoAmI register. 191 191 * @sensors_supported: List of supported sensors by struct itself. 192 192 * @ch: IIO channels for the sensor. 193 + * @num_ch: Number of IIO channels in @ch 193 194 * @odr: Output data rate register and ODR list available. 194 195 * @pw: Power register of the sensor. 195 196 * @enable_axis: Enable one or more axis of the sensor. ··· 229 228 * @regmap: Pointer to specific sensor regmap configuration. 230 229 * @enabled: Status of the sensor (false->off, true->on). 231 230 * @odr: Output data rate of the sensor [Hz]. 232 - * num_data_channels: Number of data channels used in buffer. 231 + * @num_data_channels: Number of data channels used in buffer. 233 232 * @drdy_int_pin: Redirect DRDY on pin 1 (1) or pin 2 (2). 234 233 * @int_pin_open_drain: Set the interrupt/DRDY to open drain. 235 234 * @irq: the IRQ number.