diff mbox series

usb: cdns3: Corrected comment to align with kernel-doc comment

Message ID 1619263801-5319-1-git-send-email-jrdr.linux@gmail.com
State New
Headers show
Series usb: cdns3: Corrected comment to align with kernel-doc comment | expand

Commit Message

Souptick Joarder April 24, 2021, 11:30 a.m. UTC
Kernel test robot throws below warning ->

drivers/usb/cdns3/cdns3-gadget.c:487: warning: This comment starts with
'/**', but isn't a kernel-doc comment. Refer
Documentation/doc-guide/kernel-doc.rst

This patch will silence the warning.

Reported-by: kernel test robot <lkp@intel.com>
Signed-off-by: Souptick Joarder <jrdr.linux@gmail.com>
---
 drivers/usb/cdns3/cdns3-gadget.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Randy Dunlap April 24, 2021, 3:53 p.m. UTC | #1
On 4/24/21 4:30 AM, Souptick Joarder wrote:
> Kernel test robot throws below warning ->
> 
> drivers/usb/cdns3/cdns3-gadget.c:487: warning: This comment starts with
> '/**', but isn't a kernel-doc comment. Refer
> Documentation/doc-guide/kernel-doc.rst
> 
> This patch will silence the warning.
> 
> Reported-by: kernel test robot <lkp@intel.com>
> Signed-off-by: Souptick Joarder <jrdr.linux@gmail.com>
> ---
>  drivers/usb/cdns3/cdns3-gadget.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/usb/cdns3/cdns3-gadget.c b/drivers/usb/cdns3/cdns3-gadget.c
> index 9b1bd41..0280a38 100644
> --- a/drivers/usb/cdns3/cdns3-gadget.c
> +++ b/drivers/usb/cdns3/cdns3-gadget.c
> @@ -483,7 +483,7 @@ static void __cdns3_descmiss_copy_data(struct usb_request *request,
>  	}
>  }
>  
> -/**
> +/*
>   * cdns3_wa2_descmiss_copy_data copy data from internal requests to

Please just insert a hyphen/dash between the function name and its description.

>   * request queued by class driver.
>   * @priv_ep: extended endpoint object
> 

thanks.
diff mbox series

Patch

diff --git a/drivers/usb/cdns3/cdns3-gadget.c b/drivers/usb/cdns3/cdns3-gadget.c
index 9b1bd41..0280a38 100644
--- a/drivers/usb/cdns3/cdns3-gadget.c
+++ b/drivers/usb/cdns3/cdns3-gadget.c
@@ -483,7 +483,7 @@  static void __cdns3_descmiss_copy_data(struct usb_request *request,
 	}
 }
 
-/**
+/*
  * cdns3_wa2_descmiss_copy_data copy data from internal requests to
  * request queued by class driver.
  * @priv_ep: extended endpoint object