Skip to contentSkip to conversation

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

PATCH Superseded Souptick Joarder 2 participants 2 messages Apr 24, 2021

Subsystems (2)
USB Cadence USB3 DRD IP driver

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore

Souptick Joarder

author
#0 lore raw

PATCH 1/1 usb: cdns3: Corrected comment to align with kernel-doc comment

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 <[email protected]>
Signed-off-by Souptick Joarder <[email protected]>
---
 drivers/usb/cdns3/cdns3-gadget.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/usb/cdns3/cdns3-gadget.c +1 -1
index 9b1bd41..0280a38 100644
@@ -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
Signature · 1 line
1.9.1
#1 lore raw
Quoted 19 lines · Souptick Joarder

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 <[email protected]>
Signed-off-by Souptick Joarder <[email protected]>
---
 drivers/usb/cdns3/cdns3-gadget.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/usb/cdns3/cdns3-gadget.c +0 -0
index 9b1bd41..0280a38 100644

drivers/usb/cdns3/cdns3-gadget.c static void __cdns3_descmiss_copy_data(struct usb_request *request, · line 487

Quoted 6 lines
drivers/usb/cdns3/cdns3-gadget.c +1 -1
@@ -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.

drivers/usb/cdns3/cdns3-gadget.c static void __cdns3_descmiss_copy_data(struct usb_request *request, · line 489

Quoted 3 lines
drivers/usb/cdns3/cdns3-gadget.c +0 -0
  * request queued by class driver.
  * @priv_ep: extended endpoint object

thanks.

Signature · 1 line
~Randy