The Linux Kernel Mailing List
 help / color / mirror / Atom feed
* [PATCH] fixp-arith: convert comments to kernel-doc format
@ 2026-07-31  5:06 Randy Dunlap
  2026-08-03  2:27 ` Dmitry Torokhov
  0 siblings, 1 reply; 2+ messages in thread
From: Randy Dunlap @ 2026-07-31  5:06 UTC (permalink / raw)
  To: linux-kernel; +Cc: Randy Dunlap, Jonathan Cameron, Dmitry Torokhov

Insert a hyphen ('-') in 2 places to prevent kernel-doc warnings:

Warning: include/linux/fixp-arith.h:42 This comment starts with '/**',
 but isn't a kernel-doc comment.
 * __fixp_sin32() returns the sin of an angle in degrees
Warning: include/linux/fixp-arith.h:66 This comment starts with '/**',
 but isn't a kernel-doc comment.
 * fixp_sin32() returns the sin of an angle in degrees

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Jonathan Cameron <jic23@kernel.org>
Cc: Dmitry Torokhov <dmitry.torokhov@gmail.com>

 include/linux/fixp-arith.h |    4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

--- linux-next-20260729.orig/include/linux/fixp-arith.h
+++ linux-next-20260729/include/linux/fixp-arith.h
@@ -40,7 +40,7 @@ static const s32 sin_table[] = {
 };
 
 /**
- * __fixp_sin32() returns the sin of an angle in degrees
+ * __fixp_sin32() - returns the sin of an angle in degrees
  *
  * @degrees: angle, in degrees, from 0 to 360.
  *
@@ -64,7 +64,7 @@ static inline s32 __fixp_sin32(int degre
 }
 
 /**
- * fixp_sin32() returns the sin of an angle in degrees
+ * fixp_sin32() - returns the sin of an angle in degrees
  *
  * @degrees: angle, in degrees. The angle can be positive or negative
  *

^ permalink raw reply	[flat|nested] 2+ messages in thread

* Re: [PATCH] fixp-arith: convert comments to kernel-doc format
  2026-07-31  5:06 [PATCH] fixp-arith: convert comments to kernel-doc format Randy Dunlap
@ 2026-08-03  2:27 ` Dmitry Torokhov
  0 siblings, 0 replies; 2+ messages in thread
From: Dmitry Torokhov @ 2026-08-03  2:27 UTC (permalink / raw)
  To: Randy Dunlap; +Cc: linux-kernel, Jonathan Cameron

On Thu, Jul 30, 2026 at 10:06:25PM -0700, Randy Dunlap wrote:
> Insert a hyphen ('-') in 2 places to prevent kernel-doc warnings:
> 
> Warning: include/linux/fixp-arith.h:42 This comment starts with '/**',
>  but isn't a kernel-doc comment.
>  * __fixp_sin32() returns the sin of an angle in degrees
> Warning: include/linux/fixp-arith.h:66 This comment starts with '/**',
>  but isn't a kernel-doc comment.
>  * fixp_sin32() returns the sin of an angle in degrees
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>

Applied, thank you.

-- 
Dmitry

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2026-08-03  2:28 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-07-31  5:06 [PATCH] fixp-arith: convert comments to kernel-doc format Randy Dunlap
2026-08-03  2:27 ` Dmitry Torokhov

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox