[PATCH] comedi: comedi_8254: correct kernel-doc warnings

Randy Dunlap posted 1 patch 1 day, 1 hour ago
include/linux/comedi/comedi_8254.h |    6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
[PATCH] comedi: comedi_8254: correct kernel-doc warnings
Posted by Randy Dunlap 1 day, 1 hour ago
Correct typos in 3 struct member descriptions to eliminate all
kernel-doc warnings in comedi_8254.h:

Warning: include/linux/comedi/comedi_8254.h:112 struct member 'next_div'
 not described in 'comedi_8254'
Warning: include/linux/comedi/comedi_8254.h:112 struct member 'clock_src'
 not described in 'comedi_8254'
Warning: include/linux/comedi/comedi_8254.h:112 struct member 'gate_src'
 not described in 'comedi_8254'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Ian Abbott <abbotti@mev.co.uk>
Cc: H Hartley Sweeten <hsweeten@visionengravers.com>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
---
 include/linux/comedi/comedi_8254.h |    6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

--- linux-next-20251201.orig/include/linux/comedi/comedi_8254.h
+++ linux-next-20251201/include/linux/comedi/comedi_8254.h
@@ -83,11 +83,11 @@ typedef unsigned int comedi_8254_iocb_fn
  * @divisor:		divisor for single counter
  * @divisor1:		divisor loaded into first cascaded counter
  * @divisor2:		divisor loaded into second cascaded counter
- * #next_div:		next divisor for single counter
+ * @next_div:		next divisor for single counter
  * @next_div1:		next divisor to use for first cascaded counter
  * @next_div2:		next divisor to use for second cascaded counter
- * @clock_src;		current clock source for each counter (driver specific)
- * @gate_src;		current gate source  for each counter (driver specific)
+ * @clock_src:		current clock source for each counter (driver specific)
+ * @gate_src:		current gate source  for each counter (driver specific)
  * @busy:		flags used to indicate that a counter is "busy"
  * @insn_config:	driver specific (*insn_config) callback
  */
Re: [PATCH] comedi: comedi_8254: correct kernel-doc warnings
Posted by Ian Abbott 11 hours ago
On 2025-12-14 20:27, Randy Dunlap wrote:
> Correct typos in 3 struct member descriptions to eliminate all
> kernel-doc warnings in comedi_8254.h:
> 
> Warning: include/linux/comedi/comedi_8254.h:112 struct member 'next_div'
>   not described in 'comedi_8254'
> Warning: include/linux/comedi/comedi_8254.h:112 struct member 'clock_src'
>   not described in 'comedi_8254'
> Warning: include/linux/comedi/comedi_8254.h:112 struct member 'gate_src'
>   not described in 'comedi_8254'
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> ---
> Cc: Ian Abbott <abbotti@mev.co.uk>
> Cc: H Hartley Sweeten <hsweeten@visionengravers.com>
> Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
> ---
>   include/linux/comedi/comedi_8254.h |    6 +++---
>   1 file changed, 3 insertions(+), 3 deletions(-)
> 
> --- linux-next-20251201.orig/include/linux/comedi/comedi_8254.h
> +++ linux-next-20251201/include/linux/comedi/comedi_8254.h
> @@ -83,11 +83,11 @@ typedef unsigned int comedi_8254_iocb_fn
>    * @divisor:		divisor for single counter
>    * @divisor1:		divisor loaded into first cascaded counter
>    * @divisor2:		divisor loaded into second cascaded counter
> - * #next_div:		next divisor for single counter
> + * @next_div:		next divisor for single counter
>    * @next_div1:		next divisor to use for first cascaded counter
>    * @next_div2:		next divisor to use for second cascaded counter
> - * @clock_src;		current clock source for each counter (driver specific)
> - * @gate_src;		current gate source  for each counter (driver specific)
> + * @clock_src:		current clock source for each counter (driver specific)
> + * @gate_src:		current gate source  for each counter (driver specific)
>    * @busy:		flags used to indicate that a counter is "busy"
>    * @insn_config:	driver specific (*insn_config) callback
>    */

Thanks for the correction!

Reviewed-by: Ian Abbott <abbotti@mev.co.uk>

-- 
-=( Ian Abbott <abbotti@mev.co.uk> || MEV Ltd. is a company  )=-
-=( registered in England & Wales.  Regd. number: 02862268.  )=-
-=( Regd. addr.: S11 & 12 Building 67, Europa Business Park, )=-
-=( Bird Hall Lane, STOCKPORT, SK3 0XA, UK. || www.mev.co.uk )=-