Re: [PATCH] input: cpcap-pwrbutton: remove initial kernel-doc notation

From: Mattijs Korpershoek
Date: Tue Jan 24 2023 - 04:48:02 EST


On Thu, Jan 12, 2023 at 22:38, Randy Dunlap <rdunlap@xxxxxxxxxxxxx> wrote:

> Change the beginning "/**" in the file to "/*" since it is not a
> kernel-doc comment. This prevents a kernel-doc warning:
>
> drivers/input/misc/cpcap-pwrbutton.c:2: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
> * CPCAP Power Button Input Driver
>
> Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
> Cc: Sebastian Reichel <sre@xxxxxxxxxx>
> Cc: Dmitry Torokhov <dmitry.torokhov@xxxxxxxxx>
> Cc: linux-input@xxxxxxxxxxxxxxx

Reviewed-by: Mattijs Korpershoek <mkorpershoek@xxxxxxxxxxxx>

> ---
> drivers/input/misc/cpcap-pwrbutton.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff -- a/drivers/input/misc/cpcap-pwrbutton.c b/drivers/input/misc/cpcap-pwrbutton.c
> --- a/drivers/input/misc/cpcap-pwrbutton.c
> +++ b/drivers/input/misc/cpcap-pwrbutton.c
> @@ -1,4 +1,4 @@
> -/**
> +/*
> * CPCAP Power Button Input Driver
> *
> * Copyright (C) 2017 Sebastian Reichel <sre@xxxxxxxxxx>