[05/30] iio: adc: twl6030-gpadc: Fix some misdocumentation and formatting issues
diff mbox series

Message ID 20200717165538.3275050-6-lee.jones@linaro.org
State New
Headers show
Series
  • Second batch of W=1 fixes for IIO
Related show

Commit Message

Lee Jones July 17, 2020, 4:55 p.m. UTC
Kerneldoc expects attributes/parameters to be in '@*.: ' format.

Fixes the following W=1 kernel build warning(s):

 drivers/iio/adc/twl6030-gpadc.c:110: warning: Function parameter or member 'ideal' not described in 'twl6030_gpadc_platform_data'
 drivers/iio/adc/twl6030-gpadc.c:110: warning: Function parameter or member 'channel_to_reg' not described in 'twl6030_gpadc_platform_data'

Cc: Stephen Boyd <swboyd@chromium.org>
Cc: Nishant Kamat <nskamat@ti.com>
Cc: Balaji T K <balajitk@ti.com>
Cc: Graeme Gregory <gg@slimlogic.co.uk>
Cc: Girish S Ghongdemath <girishsg@ti.com>
Cc: Ambresh K <ambresh@ti.com>
Cc: Oleksandr Kozaruk <oleksandr.kozaruk@ti.com>
Cc: Mikko Ylinen <mikko.k.ylinen@nokia.com>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/iio/adc/twl6030-gpadc.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Jonathan Cameron July 18, 2020, 3:38 p.m. UTC | #1
On Fri, 17 Jul 2020 17:55:13 +0100
Lee Jones <lee.jones@linaro.org> wrote:

> Kerneldoc expects attributes/parameters to be in '@*.: ' format.
> 
> Fixes the following W=1 kernel build warning(s):
> 
>  drivers/iio/adc/twl6030-gpadc.c:110: warning: Function parameter or member 'ideal' not described in 'twl6030_gpadc_platform_data'
>  drivers/iio/adc/twl6030-gpadc.c:110: warning: Function parameter or member 'channel_to_reg' not described in 'twl6030_gpadc_platform_data'
> 
> Cc: Stephen Boyd <swboyd@chromium.org>
> Cc: Nishant Kamat <nskamat@ti.com>
> Cc: Balaji T K <balajitk@ti.com>
> Cc: Graeme Gregory <gg@slimlogic.co.uk>
> Cc: Girish S Ghongdemath <girishsg@ti.com>
> Cc: Ambresh K <ambresh@ti.com>
> Cc: Oleksandr Kozaruk <oleksandr.kozaruk@ti.com>
> Cc: Mikko Ylinen <mikko.k.ylinen@nokia.com>
> Signed-off-by: Lee Jones <lee.jones@linaro.org>
Applied.

Thanks,

Jonathan

> ---
>  drivers/iio/adc/twl6030-gpadc.c | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/drivers/iio/adc/twl6030-gpadc.c b/drivers/iio/adc/twl6030-gpadc.c
> index f24148bd15de4..a19a6ce65e390 100644
> --- a/drivers/iio/adc/twl6030-gpadc.c
> +++ b/drivers/iio/adc/twl6030-gpadc.c
> @@ -94,9 +94,9 @@ struct twl6030_gpadc_data;
>   * struct twl6030_gpadc_platform_data - platform specific data
>   * @nchannels:		number of GPADC channels
>   * @iio_channels:	iio channels
> - * @twl6030_ideal:	pointer to calibration parameters
> + * @ideal:		pointer to calibration parameters
>   * @start_conversion:	pointer to ADC start conversion function
> - * @channel_to_reg	pointer to ADC function to convert channel to
> + * @channel_to_reg:	pointer to ADC function to convert channel to
>   *			register address for reading conversion result
>   * @calibrate:		pointer to calibration function
>   */

Patch
diff mbox series

diff --git a/drivers/iio/adc/twl6030-gpadc.c b/drivers/iio/adc/twl6030-gpadc.c
index f24148bd15de4..a19a6ce65e390 100644
--- a/drivers/iio/adc/twl6030-gpadc.c
+++ b/drivers/iio/adc/twl6030-gpadc.c
@@ -94,9 +94,9 @@  struct twl6030_gpadc_data;
  * struct twl6030_gpadc_platform_data - platform specific data
  * @nchannels:		number of GPADC channels
  * @iio_channels:	iio channels
- * @twl6030_ideal:	pointer to calibration parameters
+ * @ideal:		pointer to calibration parameters
  * @start_conversion:	pointer to ADC start conversion function
- * @channel_to_reg	pointer to ADC function to convert channel to
+ * @channel_to_reg:	pointer to ADC function to convert channel to
  *			register address for reading conversion result
  * @calibrate:		pointer to calibration function
  */