diff mbox series

[09/30] iio: temperature: mlx90632: Function parameter descriptions must match exactly

Message ID 20200717165538.3275050-10-lee.jones@linaro.org (mailing list archive)
State New, archived
Headers show
Series Second batch of W=1 fixes for IIO | expand

Commit Message

Lee Jones July 17, 2020, 4:55 p.m. UTC
'*'s are not welcome in kerneldoc parameter names.

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

 drivers/iio/temperature/mlx90632.c:175: warning: Function parameter or member 'data' not described in 'mlx90632_perform_measurement'

Cc: Crt Mori <cmo@melexis.com>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/iio/temperature/mlx90632.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Crt Mori July 17, 2020, 7:48 p.m. UTC | #1
Acked-by: Crt Mori <cmo@melexis.com>

On Fri, 17 Jul 2020 at 18:56, Lee Jones <lee.jones@linaro.org> wrote:
>
> '*'s are not welcome in kerneldoc parameter names.
>
> Fixes the following W=1 kernel build warning(s):
>
>  drivers/iio/temperature/mlx90632.c:175: warning: Function parameter or member 'data' not described in 'mlx90632_perform_measurement'
>
> Cc: Crt Mori <cmo@melexis.com>
> Signed-off-by: Lee Jones <lee.jones@linaro.org>
> ---
>  drivers/iio/temperature/mlx90632.c | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/drivers/iio/temperature/mlx90632.c b/drivers/iio/temperature/mlx90632.c
> index eaca6ba068646..b9a8089be3f63 100644
> --- a/drivers/iio/temperature/mlx90632.c
> +++ b/drivers/iio/temperature/mlx90632.c
> @@ -164,8 +164,8 @@ static s32 mlx90632_pwr_continuous(struct regmap *regmap)
>  }
>
>  /**
> - * mlx90632_perform_measurement - Trigger and retrieve current measurement cycle
> - * @*data: pointer to mlx90632_data object containing regmap information
> + * mlx90632_perform_measurement() - Trigger and retrieve current measurement cycle
> + * @data: pointer to mlx90632_data object containing regmap information
>   *
>   * Perform a measurement and return latest measurement cycle position reported
>   * by sensor. This is a blocking function for 500ms, as that is default sensor
> --
> 2.25.1
>
Jonathan Cameron July 18, 2020, 3:42 p.m. UTC | #2
On Fri, 17 Jul 2020 21:48:06 +0200
Crt Mori <cmo@melexis.com> wrote:

> Acked-by: Crt Mori <cmo@melexis.com>
> 
> On Fri, 17 Jul 2020 at 18:56, Lee Jones <lee.jones@linaro.org> wrote:
> >
> > '*'s are not welcome in kerneldoc parameter names.
> >
> > Fixes the following W=1 kernel build warning(s):
> >
> >  drivers/iio/temperature/mlx90632.c:175: warning: Function parameter or member 'data' not described in 'mlx90632_perform_measurement'
> >
> > Cc: Crt Mori <cmo@melexis.com>
> > Signed-off-by: Lee Jones <lee.jones@linaro.org>
I got lazy on bothering about the addition of optional brackets.

Applied,

Thanks,

Jonathan

> > ---
> >  drivers/iio/temperature/mlx90632.c | 4 ++--
> >  1 file changed, 2 insertions(+), 2 deletions(-)
> >
> > diff --git a/drivers/iio/temperature/mlx90632.c b/drivers/iio/temperature/mlx90632.c
> > index eaca6ba068646..b9a8089be3f63 100644
> > --- a/drivers/iio/temperature/mlx90632.c
> > +++ b/drivers/iio/temperature/mlx90632.c
> > @@ -164,8 +164,8 @@ static s32 mlx90632_pwr_continuous(struct regmap *regmap)
> >  }
> >
> >  /**
> > - * mlx90632_perform_measurement - Trigger and retrieve current measurement cycle
> > - * @*data: pointer to mlx90632_data object containing regmap information
> > + * mlx90632_perform_measurement() - Trigger and retrieve current measurement cycle
> > + * @data: pointer to mlx90632_data object containing regmap information
> >   *
> >   * Perform a measurement and return latest measurement cycle position reported
> >   * by sensor. This is a blocking function for 500ms, as that is default sensor
> > --
> > 2.25.1
> >
diff mbox series

Patch

diff --git a/drivers/iio/temperature/mlx90632.c b/drivers/iio/temperature/mlx90632.c
index eaca6ba068646..b9a8089be3f63 100644
--- a/drivers/iio/temperature/mlx90632.c
+++ b/drivers/iio/temperature/mlx90632.c
@@ -164,8 +164,8 @@  static s32 mlx90632_pwr_continuous(struct regmap *regmap)
 }
 
 /**
- * mlx90632_perform_measurement - Trigger and retrieve current measurement cycle
- * @*data: pointer to mlx90632_data object containing regmap information
+ * mlx90632_perform_measurement() - Trigger and retrieve current measurement cycle
+ * @data: pointer to mlx90632_data object containing regmap information
  *
  * Perform a measurement and return latest measurement cycle position reported
  * by sensor. This is a blocking function for 500ms, as that is default sensor