[PATCH] extcon: qcom-spmi-misc: don't use kernel-doc marker for comment

[PATCH] extcon: qcom-spmi-misc: don't use kernel-doc marker for comment

[Randy Dunlap]

Do not use "/**" for non-kernel-doc comments. This prevents a warning
from scripts/kernel-doc:

warning: expecting prototype for extcon(). Prototype was for USB_ID_DEBOUNCE_MS() instead

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Andy Gross <agross@kernel.org>
Cc: Bjorn Andersson <andersson@kernel.org>
Cc: Konrad Dybcio <konrad.dybcio@linaro.org>
Cc: MyungJoo Ham <myungjoo.ham@samsung.com>
Cc: Chanwoo Choi <cw00.choi@samsung.com>
---
 drivers/extcon/extcon-qcom-spmi-misc.c |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff -- a/drivers/extcon/extcon-qcom-spmi-misc.c b/drivers/extcon/extcon-qcom-spmi-misc.c
--- a/drivers/extcon/extcon-qcom-spmi-misc.c
+++ b/drivers/extcon/extcon-qcom-spmi-misc.c
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: GPL-2.0-only
-/**
+/*
  * extcon-qcom-spmi-misc.c - Qualcomm USB extcon driver to support USB ID
  *			and VBUS detection based on extcon-usb-gpio.c.
  *

RE: [PATCH] extcon: qcom-spmi-misc: don't use kernel-doc marker for comment

[Chanwoo Choi]

> -----Original Message-----
> From: Randy Dunlap <rdunlap@infradead.org>
> Sent: Wednesday, December 6, 2023 8:12 AM
> To: linux-kernel@vger.kernel.org
> Cc: Randy Dunlap <rdunlap@infradead.org>; Andy Gross <agross@kernel.org>;
> Bjorn Andersson <andersson@kernel.org>; Konrad Dybcio
> <konrad.dybcio@linaro.org>; MyungJoo Ham <myungjoo.ham@samsung.com>;
Chanwoo
> Choi <cw00.choi@samsung.com>
> Subject: [PATCH] extcon: qcom-spmi-misc: don't use kernel-doc marker for
> comment
> 
> Do not use "/**" for non-kernel-doc comments. This prevents a warning from
> scripts/kernel-doc:
> 
> warning: expecting prototype for extcon(). Prototype was for
> USB_ID_DEBOUNCE_MS() instead
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Andy Gross <agross@kernel.org>
> Cc: Bjorn Andersson <andersson@kernel.org>
> Cc: Konrad Dybcio <konrad.dybcio@linaro.org>
> Cc: MyungJoo Ham <myungjoo.ham@samsung.com>
> Cc: Chanwoo Choi <cw00.choi@samsung.com>
> ---
>  drivers/extcon/extcon-qcom-spmi-misc.c |    2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff -- a/drivers/extcon/extcon-qcom-spmi-misc.c b/drivers/extcon/extcon-
> qcom-spmi-misc.c
> --- a/drivers/extcon/extcon-qcom-spmi-misc.c
> +++ b/drivers/extcon/extcon-qcom-spmi-misc.c
> @@ -1,5 +1,5 @@
>  // SPDX-License-Identifier: GPL-2.0-only
> -/**
> +/*
>   * extcon-qcom-spmi-misc.c - Qualcomm USB extcon driver to support USB ID
>   *			and VBUS detection based on extcon-usb-gpio.c.
>   *

Applied it. Thanks.

Best Regards,
Chanwoo Choi