diff mbox series

[28/30] iio: magnetometer: mmc35240: Fix function header formatting

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

Commit Message

Lee Jones July 16, 2020, 1:59 p.m. UTC
All lines in the header must start with " *".

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

 drivers/iio/magnetometer/mmc35240.c:304: warning: bad line:                             compensation for output value.

Cc: Daniel Baluta <daniel.baluta@intel.com>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/iio/magnetometer/mmc35240.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Jonathan Cameron July 18, 2020, 3:16 p.m. UTC | #1
On Thu, 16 Jul 2020 14:59:26 +0100
Lee Jones <lee.jones@linaro.org> wrote:

> All lines in the header must start with " *".
> 
> Fixes the following W=1 kernel build warning(s):
> 
>  drivers/iio/magnetometer/mmc35240.c:304: warning: bad line:                             compensation for output value.
> 
> Cc: Daniel Baluta <daniel.baluta@intel.com>
> Signed-off-by: Lee Jones <lee.jones@linaro.org>
I tweaked this one a tiny bit to drop the brackets you added.
I remember looking this up recently and they are optional in the kernel-doc
format.  Adds a very small amount of confusion perhaps to add them in here.

Applied


> ---
>  drivers/iio/magnetometer/mmc35240.c | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/drivers/iio/magnetometer/mmc35240.c b/drivers/iio/magnetometer/mmc35240.c
> index 1787d656d0094..19e46b1f4ee81 100644
> --- a/drivers/iio/magnetometer/mmc35240.c
> +++ b/drivers/iio/magnetometer/mmc35240.c
> @@ -300,8 +300,8 @@ static int mmc35240_read_measurement(struct mmc35240_data *data, __le16 buf[3])
>  }
>  
>  /**
> - * mmc35240_raw_to_mgauss - convert raw readings to milli gauss. Also apply
> -			    compensation for output value.
> + * mmc35240_raw_to_mgauss() - convert raw readings to milli gauss. Also apply
> + *			      compensation for output value.
>   *
>   * @data: device private data
>   * @index: axis index for which we want the conversion
diff mbox series

Patch

diff --git a/drivers/iio/magnetometer/mmc35240.c b/drivers/iio/magnetometer/mmc35240.c
index 1787d656d0094..19e46b1f4ee81 100644
--- a/drivers/iio/magnetometer/mmc35240.c
+++ b/drivers/iio/magnetometer/mmc35240.c
@@ -300,8 +300,8 @@  static int mmc35240_read_measurement(struct mmc35240_data *data, __le16 buf[3])
 }
 
 /**
- * mmc35240_raw_to_mgauss - convert raw readings to milli gauss. Also apply
-			    compensation for output value.
+ * mmc35240_raw_to_mgauss() - convert raw readings to milli gauss. Also apply
+ *			      compensation for output value.
  *
  * @data: device private data
  * @index: axis index for which we want the conversion