OSDN Git Service

usb: dwc3: st: fix incorrect kernel-doc comment syntax in file
authorAditya Srivastava <yashsri421@gmail.com>
Mon, 29 Mar 2021 13:20:14 +0000 (18:50 +0530)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Fri, 2 Apr 2021 13:20:46 +0000 (15:20 +0200)
commitc9714d65eac862071749ea964585ae933872c721
treef6c70a4222568f956082911f9c611ec67edb2638
parented577c325b646464c4b51575073e4c678536f699
usb: dwc3: st: fix incorrect kernel-doc comment syntax in file

The opening comment mark '/**' is used for highlighting the beginning of
kernel-doc comments.
The header for drivers/usb/dwc3/dwc3-st.c follows this syntax, but the
content inside does not comply with kernel-doc.

This line was probably not meant for kernel-doc parsing, but is parsed
due to the presence of kernel-doc like comment syntax(i.e, '/**'), which
causes unexpected warning from kernel-doc:
"warning: expecting prototype for dwc3(). Prototype was for CLKRST_CTRL() instead"

Provide a simple fix by replacing this occurrence 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/20210329132014.24304-1-yashsri421@gmail.com
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
drivers/usb/dwc3/dwc3-st.c