Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

usb: dwc3: fix incorrect kernel-doc comment syntax in files

The opening comment mark '/**' is used for highlighting the beginning of
kernel-doc comments.
There are certain files in drivers/usb/dwc3, which follow this syntax,
but the content inside does not comply with kernel-doc.
Such lines were probably not meant for kernel-doc parsing, but are parsed
due to the presence of kernel-doc like comment syntax(i.e, '/**'), which
causes unexpected warnings from kernel-doc.

E.g., presence of kernel-doc like comment in drivers/usb/dwc3/io.h at
header causes this warnings by kernel-doc:
"warning: expecting prototype for h(). Prototype was for __DRIVERS_USB_DWC3_IO_H() instead"

Similarly for other files too.

Provide a simple fix by replacing such occurrences with general comment
format, i.e. '/*', to prevent kernel-doc from parsing it.

Acked-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Aditya Srivastava <yashsri421@gmail.com>
Link: https://lore.kernel.org/r/20210329135108.27128-1-yashsri421@gmail.com
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

authored by

Aditya Srivastava and committed by
Greg Kroah-Hartman
27088e00 c9714d65

+7 -7
+1 -1
drivers/usb/dwc3/debug.h
··· 1 1 /* SPDX-License-Identifier: GPL-2.0 */ 2 - /** 2 + /* 3 3 * debug.h - DesignWare USB3 DRD Controller Debug Header 4 4 * 5 5 * Copyright (C) 2010-2011 Texas Instruments Incorporated - https://www.ti.com
+1 -1
drivers/usb/dwc3/debugfs.c
··· 1 1 // SPDX-License-Identifier: GPL-2.0 2 - /** 2 + /* 3 3 * debugfs.c - DesignWare USB3 DRD Controller DebugFS file 4 4 * 5 5 * Copyright (C) 2010-2011 Texas Instruments Incorporated - https://www.ti.com
+1 -1
drivers/usb/dwc3/dwc3-keystone.c
··· 1 1 // SPDX-License-Identifier: GPL-2.0 2 - /** 2 + /* 3 3 * dwc3-keystone.c - Keystone Specific Glue layer 4 4 * 5 5 * Copyright (C) 2010-2013 Texas Instruments Incorporated - https://www.ti.com
+1 -1
drivers/usb/dwc3/dwc3-pci.c
··· 1 1 // SPDX-License-Identifier: GPL-2.0 2 - /** 2 + /* 3 3 * dwc3-pci.c - PCI Specific glue layer 4 4 * 5 5 * Copyright (C) 2010-2011 Texas Instruments Incorporated - https://www.ti.com
+1 -1
drivers/usb/dwc3/io.h
··· 1 1 /* SPDX-License-Identifier: GPL-2.0 */ 2 - /** 2 + /* 3 3 * io.h - DesignWare USB3 DRD IO Header 4 4 * 5 5 * Copyright (C) 2010-2011 Texas Instruments Incorporated - https://www.ti.com
+1 -1
drivers/usb/dwc3/trace.c
··· 1 1 // SPDX-License-Identifier: GPL-2.0 2 - /** 2 + /* 3 3 * trace.c - DesignWare USB3 DRD Controller Trace Support 4 4 * 5 5 * Copyright (C) 2014 Texas Instruments Incorporated - https://www.ti.com
+1 -1
drivers/usb/dwc3/trace.h
··· 1 1 /* SPDX-License-Identifier: GPL-2.0 */ 2 - /** 2 + /* 3 3 * trace.h - DesignWare USB3 DRD Controller Trace Support 4 4 * 5 5 * Copyright (C) 2014 Texas Instruments Incorporated - https://www.ti.com