[PATCH] iio: adc: stm32-adc: Fix docs wrongly marked as kernel-doc

[PATCH] iio: adc: stm32-adc: Fix docs wrongly marked as kernel-doc

[Jonathan Cameron]

From: Jonathan Cameron <Jonathan.Cameron@huawei.com>

W=1 highlights these two cases that are obviously not in kernel-doc
format.

Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
Cc: Fabrice Gasnier <fabrice.gasnier@foss.st.com>
---
 drivers/iio/adc/stm32-adc.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/drivers/iio/adc/stm32-adc.c b/drivers/iio/adc/stm32-adc.c
index 922af2d75c1e..5088de835bb1 100644
--- a/drivers/iio/adc/stm32-adc.c
+++ b/drivers/iio/adc/stm32-adc.c
@@ -449,7 +449,7 @@ static const struct stm32_adc_regspec stm32h7_adc_regspec = {
 	.smp_bits = stm32h7_smp_bits,
 };
 
-/**
+/*
  * STM32 ADC registers access routines
  * @adc: stm32 adc instance
  * @reg: reg offset in adc instance
@@ -851,7 +851,7 @@ static int stm32h7_adc_restore_selfcalib(struct iio_dev *indio_dev)
 	return 0;
 }
 
-/**
+/*
  * Fixed timeout value for ADC calibration.
  * worst cases:
  * - low clock frequency
-- 
2.31.1

Re: [PATCH] iio: adc: stm32-adc: Fix docs wrongly marked as kernel-doc

[Fabrice Gasnier]

On 4/28/21 9:26 PM, Jonathan Cameron wrote:
> From: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> 
> W=1 highlights these two cases that are obviously not in kernel-doc
> format.
> 
> Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> Cc: Fabrice Gasnier <fabrice.gasnier@foss.st.com>

Hi Jonathan,

I've been a bit surprised but I finally found out the checks have
evolved [1].
[1] https://lore.kernel.org/linux-next/87pmzlvi0y.fsf@meer.lwn.net/T/

It seems it's exposed by commit:
52042e2db452 ("scripts: kernel-doc: validate kernel-doc markup with the
actual names")

You can add my:
Reviewed-by: Fabrice Gasnier <fabrice.gasnier@foss.st.com>

Thanks,
Fabrice

> ---
>  drivers/iio/adc/stm32-adc.c | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/drivers/iio/adc/stm32-adc.c b/drivers/iio/adc/stm32-adc.c
> index 922af2d75c1e..5088de835bb1 100644
> --- a/drivers/iio/adc/stm32-adc.c
> +++ b/drivers/iio/adc/stm32-adc.c
> @@ -449,7 +449,7 @@ static const struct stm32_adc_regspec stm32h7_adc_regspec = {
>  	.smp_bits = stm32h7_smp_bits,
>  };
>  
> -/**
> +/*
>   * STM32 ADC registers access routines
>   * @adc: stm32 adc instance
>   * @reg: reg offset in adc instance
> @@ -851,7 +851,7 @@ static int stm32h7_adc_restore_selfcalib(struct iio_dev *indio_dev)
>  	return 0;
>  }
>  
> -/**
> +/*
>   * Fixed timeout value for ADC calibration.
>   * worst cases:
>   * - low clock frequency
> 

Re: [PATCH] iio: adc: stm32-adc: Fix docs wrongly marked as kernel-doc

[Jonathan Cameron]

On Thu, 29 Apr 2021 10:16:00 +0200
Fabrice Gasnier <fabrice.gasnier@foss.st.com> wrote:

> On 4/28/21 9:26 PM, Jonathan Cameron wrote:
> > From: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> > 
> > W=1 highlights these two cases that are obviously not in kernel-doc
> > format.
> > 
> > Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> > Cc: Fabrice Gasnier <fabrice.gasnier@foss.st.com>  
> 
> Hi Jonathan,
> 
> I've been a bit surprised but I finally found out the checks have
> evolved [1].
> [1] https://lore.kernel.org/linux-next/87pmzlvi0y.fsf@meer.lwn.net/T/
> 
> It seems it's exposed by commit:
> 52042e2db452 ("scripts: kernel-doc: validate kernel-doc markup with the
> actual names")

Good detective work.  I wondered why this one hadn't appeared before
yesterday but was too lazy to check :)

> 
> You can add my:
> Reviewed-by: Fabrice Gasnier <fabrice.gasnier@foss.st.com>

Thanks,

Jonathan

> 
> Thanks,
> Fabrice
> 
> > ---
> >  drivers/iio/adc/stm32-adc.c | 4 ++--
> >  1 file changed, 2 insertions(+), 2 deletions(-)
> > 
> > diff --git a/drivers/iio/adc/stm32-adc.c b/drivers/iio/adc/stm32-adc.c
> > index 922af2d75c1e..5088de835bb1 100644
> > --- a/drivers/iio/adc/stm32-adc.c
> > +++ b/drivers/iio/adc/stm32-adc.c
> > @@ -449,7 +449,7 @@ static const struct stm32_adc_regspec stm32h7_adc_regspec = {
> >  	.smp_bits = stm32h7_smp_bits,
> >  };
> >  
> > -/**
> > +/*
> >   * STM32 ADC registers access routines
> >   * @adc: stm32 adc instance
> >   * @reg: reg offset in adc instance
> > @@ -851,7 +851,7 @@ static int stm32h7_adc_restore_selfcalib(struct iio_dev *indio_dev)
> >  	return 0;
> >  }
> >  
> > -/**
> > +/*
> >   * Fixed timeout value for ADC calibration.
> >   * worst cases:
> >   * - low clock frequency
> >   

Re: [PATCH] iio: adc: stm32-adc: Fix docs wrongly marked as kernel-doc

[Jonathan Cameron]

On Thu, 29 Apr 2021 10:22:53 +0100
Jonathan Cameron <Jonathan.Cameron@Huawei.com> wrote:

> On Thu, 29 Apr 2021 10:16:00 +0200
> Fabrice Gasnier <fabrice.gasnier@foss.st.com> wrote:
> 
> > On 4/28/21 9:26 PM, Jonathan Cameron wrote:  
> > > From: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> > > 
> > > W=1 highlights these two cases that are obviously not in kernel-doc
> > > format.
> > > 
> > > Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> > > Cc: Fabrice Gasnier <fabrice.gasnier@foss.st.com>    
> > 
> > Hi Jonathan,
> > 
> > I've been a bit surprised but I finally found out the checks have
> > evolved [1].
> > [1] https://lore.kernel.org/linux-next/87pmzlvi0y.fsf@meer.lwn.net/T/
> > 
> > It seems it's exposed by commit:
> > 52042e2db452 ("scripts: kernel-doc: validate kernel-doc markup with the
> > actual names")  
> 
> Good detective work.  I wondered why this one hadn't appeared before
> yesterday but was too lazy to check :)
> 
> > 
> > You can add my:
> > Reviewed-by: Fabrice Gasnier <fabrice.gasnier@foss.st.com>  

Applied to the togreg branch of iio.git and pushed out as testing for the
autobuilders to see if we missed anything.

Thanks,

Jonathan

> 
> Thanks,
> 
> Jonathan
> 
> > 
> > Thanks,
> > Fabrice
> >   
> > > ---
> > >  drivers/iio/adc/stm32-adc.c | 4 ++--
> > >  1 file changed, 2 insertions(+), 2 deletions(-)
> > > 
> > > diff --git a/drivers/iio/adc/stm32-adc.c b/drivers/iio/adc/stm32-adc.c
> > > index 922af2d75c1e..5088de835bb1 100644
> > > --- a/drivers/iio/adc/stm32-adc.c
> > > +++ b/drivers/iio/adc/stm32-adc.c
> > > @@ -449,7 +449,7 @@ static const struct stm32_adc_regspec stm32h7_adc_regspec = {
> > >  	.smp_bits = stm32h7_smp_bits,
> > >  };
> > >  
> > > -/**
> > > +/*
> > >   * STM32 ADC registers access routines
> > >   * @adc: stm32 adc instance
> > >   * @reg: reg offset in adc instance
> > > @@ -851,7 +851,7 @@ static int stm32h7_adc_restore_selfcalib(struct iio_dev *indio_dev)
> > >  	return 0;
> > >  }
> > >  
> > > -/**
> > > +/*
> > >   * Fixed timeout value for ADC calibration.
> > >   * worst cases:
> > >   * - low clock frequency
> > >     
>