# \[PATCH\] input/misc: max8925\_onkey.c: don't mark comment as kernel-doc

- Status: LANDED (a88638c4e69c · 2021-10-16 05:10)
- Landed in mainline as a88638c4e69c on 2021-10-16.
- List: linux-input
- 2 messages, 2 authors
- Page: https://ratatoskr.run/linux-input/2021/10/1528693/t

## \[PATCH\] input/misc: max8925\_onkey.c: don't mark comment as kernel-doc

- From: Randy Dunlap \<rdunlap@infradead.org\>
- Date: 2021-10-02 04:59:51 
- Message: https://ratatoskr.run/linux-input/2021/10/1528693.md

```text
Change the comment to a normal (non-kernel-doc) comment to avoid
these kernel-doc warnings:

max8925_onkey.c:2: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * MAX8925 ONKEY driver
max8925_onkey.c:2: warning: missing initial short description on line:
 * MAX8925 ONKEY driver

Fixes: 3734574cac100 ("Input: enable onkey driver of max8925")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Reported-by: kernel test robot <redacted>
Cc: Aditya Srivastava <redacted>
Cc: Dmitry Torokhov <dmitry.torokhov@gmail.com>
Cc: <redacted>
Cc: Haojian Zhuang <haojian.zhuang@gmail.com>
---
 drivers/input/misc/max8925_onkey.c |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

--- linux-next-20211001.orig/drivers/input/misc/max8925_onkey.c
+++ linux-next-20211001/drivers/input/misc/max8925_onkey.c
@@ -1,4 +1,4 @@
-/**
+/*
  * MAX8925 ONKEY driver
  *
  * Copyright (C) 2009 Marvell International Ltd.
```

## Re: \[PATCH\] input/misc: max8925\_onkey.c: don't mark comment as kernel-doc

- From: Dmitry Torokhov \<dmitry.torokhov@gmail.com\>
- Date: 2021-10-16 05:09:31 
- Message: https://ratatoskr.run/linux-input/2021/10/1544031.md

```text
On Fri, Oct 01, 2021 at 09:59:43PM -0700, Randy Dunlap wrote:
> Change the comment to a normal (non-kernel-doc) comment to avoid
> these kernel-doc warnings:
> 
> max8925_onkey.c:2: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  * MAX8925 ONKEY driver
> max8925_onkey.c:2: warning: missing initial short description on line:
>  * MAX8925 ONKEY driver
> 
> Fixes: 3734574cac100 ("Input: enable onkey driver of max8925")
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Reported-by: kernel test robot <redacted>
> Cc: Aditya Srivastava <redacted>
> Cc: Dmitry Torokhov <dmitry.torokhov@gmail.com>
> Cc: <redacted>
> Cc: Haojian Zhuang <haojian.zhuang@gmail.com>

Applied, thank you.

-- 
Dmitry
```