2021-03-15 13:39:14

by Mugilraj Dhavachelvan

[permalink] [raw]
Subject: [PATCH] staging: iio: ad9832: kernel-doc fixes

Fixes a W=1 warning.
-Added ``:`` to lock parameter in 'ad9832_state' description.
-It's a reference comment so removed /**

Signed-off-by: Mugilraj Dhavachelvan <[email protected]>
---
drivers/staging/iio/frequency/ad9832.c | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/drivers/staging/iio/frequency/ad9832.c b/drivers/staging/iio/frequency/ad9832.c
index 74308a2e72db..e31ebba47a3c 100644
--- a/drivers/staging/iio/frequency/ad9832.c
+++ b/drivers/staging/iio/frequency/ad9832.c
@@ -86,7 +86,7 @@
* @freq_msg: tuning word spi message
* @phase_xfer: tuning word spi transfer
* @phase_msg: tuning word spi message
- * @lock protect sensor state
+ * @lock: protect sensor state
* @data: spi transmit buffer
* @phase_data: tuning word spi transmit buffer
* @freq_data: tuning word spi transmit buffer
@@ -248,7 +248,7 @@ static ssize_t ad9832_write(struct device *dev, struct device_attribute *attr,
return ret ? ret : len;
}

-/**
+/*
* see dds.h for further information
*/

--
2.25.1


2021-03-20 14:43:22

by Jonathan Cameron

[permalink] [raw]
Subject: Re: [PATCH] staging: iio: ad9832: kernel-doc fixes

On Mon, 15 Mar 2021 19:07:11 +0530
Mugilraj Dhavachelvan <[email protected]> wrote:

> Fixes a W=1 warning.
> -Added ``:`` to lock parameter in 'ad9832_state' description.
> -It's a reference comment so removed /**
>
> Signed-off-by: Mugilraj Dhavachelvan <[email protected]>

Great. Thanks for tidying this up.

Applied to the togreg branch of iio.git and pushed out for testing
to let the autobuilders poke at it.

thanks

Jonathan

> ---
> drivers/staging/iio/frequency/ad9832.c | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/drivers/staging/iio/frequency/ad9832.c b/drivers/staging/iio/frequency/ad9832.c
> index 74308a2e72db..e31ebba47a3c 100644
> --- a/drivers/staging/iio/frequency/ad9832.c
> +++ b/drivers/staging/iio/frequency/ad9832.c
> @@ -86,7 +86,7 @@
> * @freq_msg: tuning word spi message
> * @phase_xfer: tuning word spi transfer
> * @phase_msg: tuning word spi message
> - * @lock protect sensor state
> + * @lock: protect sensor state
> * @data: spi transmit buffer
> * @phase_data: tuning word spi transmit buffer
> * @freq_data: tuning word spi transmit buffer
> @@ -248,7 +248,7 @@ static ssize_t ad9832_write(struct device *dev, struct device_attribute *attr,
> return ret ? ret : len;
> }
>
> -/**
> +/*
> * see dds.h for further information
> */
>