Re: [PATCH 10/30] iio: light: us5182d: Fix formatting in kerneldoc function block

From: Jonathan Cameron
Date: Sat Jul 18 2020 - 11:44:23 EST


On Fri, 17 Jul 2020 17:55:18 +0100
Lee Jones <lee.jones@xxxxxxxxxx> wrote:

> Kerneldoc expects attributes/parameters to be in '@*.: ' format.
>
> Fixes the following W=1 kernel build warning(s):
>
> drivers/iio/light/us5182d.c:457: warning: Function parameter or member 'data' not described in 'us5182d_update_dark_th'
> drivers/iio/light/us5182d.c:457: warning: Function parameter or member 'index' not described in 'us5182d_update_dark_th'
> drivers/iio/light/us5182d.c:479: warning: Function parameter or member 'data' not described in 'us5182d_apply_scale'
> drivers/iio/light/us5182d.c:479: warning: Function parameter or member 'index' not described in 'us5182d_apply_scale'
>
> Cc: Adriana Reus <adriana.reus@xxxxxxxxx>
> Signed-off-by: Lee Jones <lee.jones@xxxxxxxxxx>
Applied.

Thanks,

Jonathan

> ---
> drivers/iio/light/us5182d.c | 8 ++++----
> 1 file changed, 4 insertions(+), 4 deletions(-)
>
> diff --git a/drivers/iio/light/us5182d.c b/drivers/iio/light/us5182d.c
> index b995f21a33479..24843597beba5 100644
> --- a/drivers/iio/light/us5182d.c
> +++ b/drivers/iio/light/us5182d.c
> @@ -446,8 +446,8 @@ static int us5182d_read_raw(struct iio_dev *indio_dev,
>
> /**
> * us5182d_update_dark_th - update Darh_Th registers
> - * @data us5182d_data structure
> - * @index index in us5182d_dark_ths array to use for the updated value
> + * @data: us5182d_data structure
> + * @index: index in us5182d_dark_ths array to use for the updated value
> *
> * Function needs to be called with a lock held because it needs two i2c write
> * byte operations as these registers (0x27 0x28) don't work in word mode
> @@ -469,8 +469,8 @@ static int us5182d_update_dark_th(struct us5182d_data *data, int index)
>
> /**
> * us5182d_apply_scale - update the ALS scale
> - * @data us5182d_data structure
> - * @index index in us5182d_scales array to use for the updated value
> + * @data: us5182d_data structure
> + * @index: index in us5182d_scales array to use for the updated value
> *
> * Function needs to be called with a lock held as we're having more than one
> * i2c operation.