mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
* [PATCH v2] staging: most: dim2: fix non-kernel-doc comment in errors.h
@ 2026-11-02 10:02 Maria Sheikh
  0 siblings, 0 replies; only message in thread
From: Maria Sheikh @ 2026-11-02 10:02 UTC (permalink / raw)
  To: outreachy, parthiban.veerasooran, christian.gromm, gregkh,
	linux-staging, linux-kernel
  Cc: Maria Sheikh

The comment above enum dim_errors_t starts with "/**" but it is not in
kernel-doc format, which scripts/kernel-doc -none reports as a warning.
Use a regular comment instead.

Found using scripts/kernel-doc -none

Signed-off-by: Maria Sheikh <mariasheikh812@gmail.com>
---
Changes in v2:
	- Use a single line comment, as suggested by Julia Lawall.
	- Converting it to kernel-doc was tried, but it produced
	  warnings for ever enum value and its inline comments, so a regular 
	  comment is used. 


 drivers/staging/most/dim2/errors.h | 4 +---
 1 file changed, 1 insertion(+), 3 deletions(-)

diff --git a/drivers/staging/most/dim2/errors.h b/drivers/staging/most/dim2/errors.h
index d707daaac3b6..966b0c731921 100644
--- a/drivers/staging/most/dim2/errors.h
+++ b/drivers/staging/most/dim2/errors.h
@@ -9,9 +9,7 @@
 #ifndef _MOST_DIM_ERRORS_H
 #define _MOST_DIM_ERRORS_H
 
-/**
- * MOST DIM errors.
- */
+/* MOST DIM errors. */
 enum dim_errors_t {
 	/** Not an error */
 	DIM_NO_ERROR = 0,
-- 
2.53.0


^ permalink raw reply	[flat|nested] only message in thread

only message in thread, other threads:[~2026-11-02 10:15 UTC | newest]

Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2026-11-02 10:02 [PATCH v2] staging: most: dim2: fix non-kernel-doc comment in errors.h Maria Sheikh

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

all inboxes | Powered by JetHome®