iio: adc: ad7606: fix kernel-doc comments

Fix several issues with kernel-doc comments in ad7606.h:
* Add missing ":" to @param names.
* Fix order of @param names.
* Add some missing parameters.
* Remove some non-existent parameters.
* Fix alignment and wrapping.
* Fix some spelling.

`./scripts/kernel-doc -v -none drivers/iio/adc/ad7606*` is happy now.

Reviewed-by: Nuno Sá <nuno.sa@analog.com>
Signed-off-by: David Lechner <dlechner@baylibre.com>
Link: https://patch.msgid.link/20250318-iio-adc-ad7606-improvements-v2-5-4b605427774c@baylibre.com
Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>

diff --git a/drivers/iio/adc/ad7606.h b/drivers/iio/adc/ad7606.h
index 71a3052..dd4ae59 100644 (file)
--- a/drivers/iio/adc/ad7606.h
+++ b/drivers/iio/adc/ad7606.h
@@ -120,17 +120,17 @@ typedef int (*ad7606_sw_setup_cb_t)(struct iio_dev *indio_dev);
 /**
  * struct ad7606_chip_info - chip specific information
  * @channels:          channel specification
- * @max_samplerate:    maximum supported samplerate
- * @name               device name
- * @num_channels:      number of channels
- * @num_adc_channels   the number of channels the ADC actually inputs.
+ * @max_samplerate:    maximum supported sample rate
+ * @name:              device name
+ * @num_adc_channels:  the number of physical voltage inputs
+ * @num_channels:      number of IIO channels
  * @scale_setup_cb:    callback to setup the scales for each channel
  * @sw_setup_cb:       callback to setup the software mode if available.
- * @oversampling_avail pointer to the array which stores the available
+ * @oversampling_avail:        pointer to the array which stores the available
  *                     oversampling ratios.
- * @oversampling_num   number of elements stored in oversampling_avail array
- * @os_req_reset       some devices require a reset to update oversampling
- * @init_delay_ms      required delay in milliseconds for initialization
+ * @oversampling_num:  number of elements stored in oversampling_avail array
+ * @os_req_reset:      some devices require a reset to update oversampling
+ * @init_delay_ms:     required delay in milliseconds for initialization
  *                     after a restart
  */
 struct ad7606_chip_info {
@@ -149,10 +149,10 @@ struct ad7606_chip_info {
 
 /**
  * struct ad7606_chan_scale - channel scale configuration
- * @scale_avail                pointer to the array which stores the available scales
- * @num_scales         number of elements stored in the scale_avail array
- * @range              voltage range selection, selects which scale to apply
- * @reg_offset         offset for the register value, to be applied when
+ * @scale_avail:       pointer to the array which stores the available scales
+ * @num_scales:                number of elements stored in the scale_avail array
+ * @range:             voltage range selection, selects which scale to apply
+ * @reg_offset:                offset for the register value, to be applied when
  *                     writing the value of 'range' to the register value
  */
 struct ad7606_chan_scale {
@@ -165,32 +165,33 @@ struct ad7606_chan_scale {
 
 /**
  * struct ad7606_state - driver instance specific data
- * @dev                pointer to kernel device
- * @chip_info          entry in the table of chips that describes this device
- * @bops               bus operations (SPI or parallel)
- * @chan_scales                scale configuration for channels
- * @oversampling       oversampling selection
- * @cnvst_pwm          pointer to the PWM device connected to the cnvst pin
- * @base_address       address from where to read data in parallel operation
- * @sw_mode_en         software mode enabled
- * @oversampling_avail pointer to the array which stores the available
+ * @dev:               pointer to kernel device
+ * @chip_info:         entry in the table of chips that describes this device
+ * @bops:              bus operations (SPI or parallel)
+ * @chan_scales:       scale configuration for channels
+ * @oversampling:      oversampling selection
+ * @cnvst_pwm:         pointer to the PWM device connected to the cnvst pin
+ * @base_address:      address from where to read data in parallel operation
+ * @sw_mode_en:                software mode enabled
+ * @oversampling_avail:        pointer to the array which stores the available
  *                     oversampling ratios.
- * @num_os_ratios      number of elements stored in oversampling_avail array
- * @write_scale                pointer to the function which writes the scale
- * @write_os           pointer to the function which writes the os
- * @lock               protect sensor state from concurrent accesses to GPIOs
- * @gpio_convst        GPIO descriptor for conversion start signal (CONVST)
- * @gpio_reset         GPIO descriptor for device hard-reset
- * @gpio_range         GPIO descriptor for range selection
- * @gpio_standby       GPIO descriptor for stand-by signal (STBY),
+ * @num_os_ratios:     number of elements stored in oversampling_avail array
+ * @back:              pointer to the iio_backend structure, if used
+ * @write_scale:       pointer to the function which writes the scale
+ * @write_os:          pointer to the function which writes the os
+ * @lock:              protect sensor state from concurrent accesses to GPIOs
+ * @gpio_convst:       GPIO descriptor for conversion start signal (CONVST)
+ * @gpio_reset:                GPIO descriptor for device hard-reset
+ * @gpio_range:                GPIO descriptor for range selection
+ * @gpio_standby:      GPIO descriptor for stand-by signal (STBY),
  *                     controls power-down mode of device
- * @gpio_frstdata      GPIO descriptor for reading from device when data
+ * @gpio_frstdata:     GPIO descriptor for reading from device when data
  *                     is being read on the first channel
- * @gpio_os            GPIO descriptors to control oversampling on the device
- * @complete           completion to indicate end of conversion
- * @trig               The IIO trigger associated with the device.
- * @data               buffer for reading data from the device
- * @d16                        be16 buffer for reading data from the device
+ * @gpio_os:           GPIO descriptors to control oversampling on the device
+ * @trig:              The IIO trigger associated with the device.
+ * @completion:                completion to indicate end of conversion
+ * @data:              buffer for reading data from the device
+ * @d16:               be16 buffer for reading data from the device
  */
 struct ad7606_state {
        struct device                   *dev;
@@ -232,17 +233,16 @@ struct ad7606_state {
 
 /**
  * struct ad7606_bus_ops - driver bus operations
- * @iio_backend_config function pointer for configuring the iio_backend for
+ * @iio_backend_config:        function pointer for configuring the iio_backend for
  *                     the compatibles that use it
- * @read_block         function pointer for reading blocks of data
+ * @read_block:                function pointer for reading blocks of data
  * @sw_mode_config:    pointer to a function which configured the device
  *                     for software mode
- * @reg_read   function pointer for reading spi register
- * @reg_write  function pointer for writing spi register
- * @write_mask function pointer for write spi register with mask
- * @update_scan_mode   function pointer for handling the calls to iio_info's update_scan
- *                     mode when enabling/disabling channels.
- * @rd_wr_cmd  pointer to the function which calculates the spi address
+ * @reg_read:          function pointer for reading spi register
+ * @reg_write:         function pointer for writing spi register
+ * @update_scan_mode:  function pointer for handling the calls to iio_info's
+ *                     update_scan mode when enabling/disabling channels.
+ * @rd_wr_cmd:         pointer to the function which calculates the spi address
  */
 struct ad7606_bus_ops {
        /* more methods added in future? */
@@ -258,9 +258,9 @@ struct ad7606_bus_ops {
 };
 
 /**
- * struct ad7606_bus_info - agregate ad7606_chip_info and ad7606_bus_ops
- * @chip_info          entry in the table of chips that describes this device
- * @bops               bus operations (SPI or parallel)
+ * struct ad7606_bus_info - aggregate ad7606_chip_info and ad7606_bus_ops
+ * @chip_info:         entry in the table of chips that describes this device
+ * @bops:              bus operations (SPI or parallel)
  */
 struct ad7606_bus_info {
        const struct ad7606_chip_info   *chip_info;