lkml.org 
[lkml]   [2020]   [Jul]   [18]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCH 25/30] iio: dac: ad5764: Fix misdocumenting and formatting error
On Thu, 16 Jul 2020 14:59:23 +0100
Lee Jones <lee.jones@linaro.org> wrote:

> Attribute descriptions must match the name exactly.
>
> Kerneldoc expects attributes/parameters to be in '@*.: ' format.
>
> Fixes the following W=1 kernel build warning(s):
>
> drivers/iio/dac/ad5764.c:42: warning: Function parameter or member 'channels' not described in 'ad5764_chip_info'
> drivers/iio/dac/ad5764.c:67: warning: Function parameter or member 'lock' not described in 'ad5764_state'
>
> Cc: Michael Hennerich <Michael.Hennerich@analog.com>
> Signed-off-by: Lee Jones <lee.jones@linaro.org>
Applied.

Thanks,

Jonathan

> ---
> drivers/iio/dac/ad5764.c | 5 ++---
> 1 file changed, 2 insertions(+), 3 deletions(-)
>
> diff --git a/drivers/iio/dac/ad5764.c b/drivers/iio/dac/ad5764.c
> index 5b0f0fe354f6b..1e16c464241c4 100644
> --- a/drivers/iio/dac/ad5764.c
> +++ b/drivers/iio/dac/ad5764.c
> @@ -33,9 +33,8 @@
> * struct ad5764_chip_info - chip specific information
> * @int_vref: Value of the internal reference voltage in uV - 0 if external
> * reference voltage is used
> - * @channel channel specification
> + * @channels: channel specification
> */
> -
> struct ad5764_chip_info {
> unsigned long int_vref;
> const struct iio_chan_spec *channels;
> @@ -46,7 +45,7 @@ struct ad5764_chip_info {
> * @spi: spi_device
> * @chip_info: chip info
> * @vref_reg: vref supply regulators
> - * @lock lock to protect the data buffer during SPI ops
> + * @lock: lock to protect the data buffer during SPI ops
> * @data: spi transfer buffers
> */
>

\
 
 \ /
  Last update: 2020-07-18 17:11    [W:0.306 / U:1.548 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site