counter: stm32-lptimer-cnt: fix a kernel-doc warning
diff mbox series

Message ID 1568809361-26157-1-git-send-email-fabrice.gasnier@st.com
State In Next
Commit 81ba7e85d7f3af053b06e8538f7c847587d53935
Headers show
Series
  • counter: stm32-lptimer-cnt: fix a kernel-doc warning
Related show

Commit Message

Fabrice Gasnier Sept. 18, 2019, 12:22 p.m. UTC
Fix the following warnings when documentation is built:
drivers/counter/stm32-lptimer-cnt.c:354: warning: cannot understand
function prototype: 'enum stm32_lptim_cnt_function'

Signed-off-by: Fabrice Gasnier <fabrice.gasnier@st.com>
---
 drivers/counter/stm32-lptimer-cnt.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

William Breathitt Gray Sept. 25, 2019, 11:51 p.m. UTC | #1
On Wed, Sep 18, 2019 at 02:22:41PM +0200, Fabrice Gasnier wrote:
> Fix the following warnings when documentation is built:
> drivers/counter/stm32-lptimer-cnt.c:354: warning: cannot understand
> function prototype: 'enum stm32_lptim_cnt_function'
> 
> Signed-off-by: Fabrice Gasnier <fabrice.gasnier@st.com>
> ---
>  drivers/counter/stm32-lptimer-cnt.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/counter/stm32-lptimer-cnt.c b/drivers/counter/stm32-lptimer-cnt.c
> index bbc930a..28b6364 100644
> --- a/drivers/counter/stm32-lptimer-cnt.c
> +++ b/drivers/counter/stm32-lptimer-cnt.c
> @@ -347,7 +347,7 @@ static const struct iio_chan_spec stm32_lptim_cnt_channels = {
>  };
>  
>  /**
> - * stm32_lptim_cnt_function - enumerates stm32 LPTimer counter & encoder modes
> + * enum stm32_lptim_cnt_function - enumerates LPTimer counter & encoder modes
>   * @STM32_LPTIM_COUNTER_INCREASE: up count on IN1 rising, falling or both edges
>   * @STM32_LPTIM_ENCODER_BOTH_EDGE: count on both edges (IN1 & IN2 quadrature)
>   */
> -- 
> 2.7.4

Fixes: 597f55e3f36c ("counter: stm32-lptimer: add counter device")

Jonathan, please pick this fix up through IIO.

Thanks,

William Breathitt Gray
Jonathan Cameron Oct. 5, 2019, 2:29 p.m. UTC | #2
On Wed, 25 Sep 2019 19:51:12 -0400
William Breathitt Gray <vilhelm.gray@gmail.com> wrote:

> On Wed, Sep 18, 2019 at 02:22:41PM +0200, Fabrice Gasnier wrote:
> > Fix the following warnings when documentation is built:
> > drivers/counter/stm32-lptimer-cnt.c:354: warning: cannot understand
> > function prototype: 'enum stm32_lptim_cnt_function'
> > 
> > Signed-off-by: Fabrice Gasnier <fabrice.gasnier@st.com>
> > ---
> >  drivers/counter/stm32-lptimer-cnt.c | 2 +-
> >  1 file changed, 1 insertion(+), 1 deletion(-)
> > 
> > diff --git a/drivers/counter/stm32-lptimer-cnt.c b/drivers/counter/stm32-lptimer-cnt.c
> > index bbc930a..28b6364 100644
> > --- a/drivers/counter/stm32-lptimer-cnt.c
> > +++ b/drivers/counter/stm32-lptimer-cnt.c
> > @@ -347,7 +347,7 @@ static const struct iio_chan_spec stm32_lptim_cnt_channels = {
> >  };
> >  
> >  /**
> > - * stm32_lptim_cnt_function - enumerates stm32 LPTimer counter & encoder modes
> > + * enum stm32_lptim_cnt_function - enumerates LPTimer counter & encoder modes
> >   * @STM32_LPTIM_COUNTER_INCREASE: up count on IN1 rising, falling or both edges
> >   * @STM32_LPTIM_ENCODER_BOTH_EDGE: count on both edges (IN1 & IN2 quadrature)
> >   */
> > -- 
> > 2.7.4  
> 
> Fixes: 597f55e3f36c ("counter: stm32-lptimer: add counter device")
> 
> Jonathan, please pick this fix up through IIO.
> 
> Thanks,
> 
> William Breathitt Gray
Applied to the togreg branch of iio.git and pushed out as testing.

thanks,

Jonathan

Patch
diff mbox series

diff --git a/drivers/counter/stm32-lptimer-cnt.c b/drivers/counter/stm32-lptimer-cnt.c
index bbc930a..28b6364 100644
--- a/drivers/counter/stm32-lptimer-cnt.c
+++ b/drivers/counter/stm32-lptimer-cnt.c
@@ -347,7 +347,7 @@  static const struct iio_chan_spec stm32_lptim_cnt_channels = {
 };
 
 /**
- * stm32_lptim_cnt_function - enumerates stm32 LPTimer counter & encoder modes
+ * enum stm32_lptim_cnt_function - enumerates LPTimer counter & encoder modes
  * @STM32_LPTIM_COUNTER_INCREASE: up count on IN1 rising, falling or both edges
  * @STM32_LPTIM_ENCODER_BOTH_EDGE: count on both edges (IN1 & IN2 quadrature)
  */