diff mbox series

[05/24] usb: dwc2: params: Fix naming of 'dwc2_get_hwparams()' in the docs

Message ID 20210526130037.856068-6-lee.jones@linaro.org
State New
Headers show
Series Rid W=1 warnings from USB | expand

Commit Message

Lee Jones May 26, 2021, 1 p.m. UTC
Fixes the following W=1 kernel build warning(s):

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

Cc: Minas Harutyunyan <hminas@synopsys.com>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: linux-usb@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>

---
 drivers/usb/dwc2/params.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

-- 
2.31.1

Comments

Minas Harutyunyan May 26, 2021, 3:10 p.m. UTC | #1
On 5/26/2021 5:00 PM, Lee Jones wrote:
> Fixes the following W=1 kernel build warning(s):

> 

>   drivers/usb/dwc2/params.c:787: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

> 

> Cc: Minas Harutyunyan <hminas@synopsys.com>

> Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

> Cc: linux-usb@vger.kernel.org

> Signed-off-by: Lee Jones <lee.jones@linaro.org>



Acked-by: Minas Harutyunyan <Minas.Harutyunyan@synopsys.com>



> ---

>   drivers/usb/dwc2/params.c | 4 ++--

>   1 file changed, 2 insertions(+), 2 deletions(-)

> 

> diff --git a/drivers/usb/dwc2/params.c b/drivers/usb/dwc2/params.c

> index 7a6089fa81e1d..67c5eb1402325 100644

> --- a/drivers/usb/dwc2/params.c

> +++ b/drivers/usb/dwc2/params.c

> @@ -784,8 +784,8 @@ static void dwc2_get_dev_hwparams(struct dwc2_hsotg *hsotg)

>   }

>   

>   /**

> - * During device initialization, read various hardware configuration

> - * registers and interpret the contents.

> + * dwc2_get_hwparams() - During device initialization, read various hardware

> + *                       configuration registers and interpret the contents.

>    *

>    * @hsotg: Programming view of the DWC_otg controller

>    *

>
diff mbox series

Patch

diff --git a/drivers/usb/dwc2/params.c b/drivers/usb/dwc2/params.c
index 7a6089fa81e1d..67c5eb1402325 100644
--- a/drivers/usb/dwc2/params.c
+++ b/drivers/usb/dwc2/params.c
@@ -784,8 +784,8 @@  static void dwc2_get_dev_hwparams(struct dwc2_hsotg *hsotg)
 }
 
 /**
- * During device initialization, read various hardware configuration
- * registers and interpret the contents.
+ * dwc2_get_hwparams() - During device initialization, read various hardware
+ *                       configuration registers and interpret the contents.
  *
  * @hsotg: Programming view of the DWC_otg controller
  *