Re: [PATCH 21/57] staging: iio: frequency: ad9834: Provide missing description for 'devid'

[Jonathan Cameron]

On Wed, 14 Apr 2021 19:10:53 +0100
Lee Jones <lee.jones@xxxxxxxxxx> wrote:

> Also demote kernel-doc abuses
> 
> Fixes the following W=1 kernel build warning(s):
> 
>  drivers/staging/iio/frequency/ad9834.c:87: warning: Function parameter or member 'devid' not described in 'ad9834_state'
>  drivers/staging/iio/frequency/ad9834.c:93: warning: cannot understand function prototype: 'enum ad9834_supported_device_ids '
>  drivers/staging/iio/frequency/ad9834.c:320: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
> 
> Cc: Lars-Peter Clausen <lars@xxxxxxxxxx>
> Cc: Michael Hennerich <Michael.Hennerich@xxxxxxxxxx>
> Cc: Jonathan Cameron <jic23@xxxxxxxxxx>
> Cc: Greg Kroah-Hartman <gregkh@xxxxxxxxxxxxxxxxxxx>
> Cc: linux-iio@xxxxxxxxxxxxxxx
> Cc: linux-staging@xxxxxxxxxxxxxxx
> Signed-off-by: Lee Jones <lee.jones@xxxxxxxxxx>

I was leaving the staging stuff in IIO related to W=1 as good material
for newbies, but I guess if you are blanket cleaning it up then fair
enough.

Sounds like Greg will take the whole series so,

Acked-by: Jonathan Cameron <Jonathan.Cameron@xxxxxxxxxx>

> ---
>  drivers/staging/iio/frequency/ad9834.c | 5 +++--
>  1 file changed, 3 insertions(+), 2 deletions(-)
> 
> diff --git a/drivers/staging/iio/frequency/ad9834.c b/drivers/staging/iio/frequency/ad9834.c
> index 60a3ae5587b90..94b131ef8a22c 100644
> --- a/drivers/staging/iio/frequency/ad9834.c
> +++ b/drivers/staging/iio/frequency/ad9834.c
> @@ -58,6 +58,7 @@
>   * @spi:		spi_device
>   * @mclk:		external master clock
>   * @control:		cached control word
> + * @devid:		device id
>   * @xfer:		default spi transfer
>   * @msg:		default spi message
>   * @freq_xfer:		tuning word spi transfer
> @@ -86,7 +87,7 @@ struct ad9834_state {
>  	__be16				freq_data[2];
>  };
>  
> -/**
> +/*
>   * ad9834_supported_device_ids:
>   */
>  
> @@ -316,7 +317,7 @@ ssize_t ad9834_show_out1_wavetype_available(struct device *dev,
>  static IIO_DEVICE_ATTR(out_altvoltage0_out1_wavetype_available, 0444,
>  		       ad9834_show_out1_wavetype_available, NULL, 0);
>  
> -/**
> +/*
>   * see dds.h for further information
>   */
>