Commit 27088e00 authored Mar 29, 2021 by Aditya Srivastava Committed by Greg Kroah-Hartman Apr 02, 2021

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>

parent c9714d65

drivers/usb/dwc3/debug.h

+1 −1

Original line number	Diff line number	Diff line
		/* SPDX-License-Identifier: GPL-2.0 */
		/**
		/*
		* debug.h - DesignWare USB3 DRD Controller Debug Header
		*
		* Copyright (C) 2010-2011 Texas Instruments Incorporated - https://www.ti.com

drivers/usb/dwc3/debugfs.c

+1 −1

Original line number	Diff line number	Diff line
		// SPDX-License-Identifier: GPL-2.0
		/**
		/*
		* debugfs.c - DesignWare USB3 DRD Controller DebugFS file
		*
		* Copyright (C) 2010-2011 Texas Instruments Incorporated - https://www.ti.com

drivers/usb/dwc3/dwc3-keystone.c

+1 −1

Original line number	Diff line number	Diff line
		// SPDX-License-Identifier: GPL-2.0
		/**
		/*
		* dwc3-keystone.c - Keystone Specific Glue layer
		*
		* Copyright (C) 2010-2013 Texas Instruments Incorporated - https://www.ti.com

drivers/usb/dwc3/dwc3-pci.c

+1 −1

Original line number	Diff line number	Diff line
		// SPDX-License-Identifier: GPL-2.0
		/**
		/*
		* dwc3-pci.c - PCI Specific glue layer
		*
		* Copyright (C) 2010-2011 Texas Instruments Incorporated - https://www.ti.com

drivers/usb/dwc3/io.h

+1 −1

Original line number	Diff line number	Diff line
		/* SPDX-License-Identifier: GPL-2.0 */
		/**
		/*
		* io.h - DesignWare USB3 DRD IO Header
		*
		* Copyright (C) 2010-2011 Texas Instruments Incorporated - https://www.ti.com