USB: gadget: udc: fix kernel-doc syntax in file headers
authorAditya Srivastava <yashsri421@gmail.com>
Sat, 22 May 2021 11:52:27 +0000 (17:22 +0530)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Mon, 24 May 2021 13:27:03 +0000 (15:27 +0200)
commit1eef7953129c3c1d0ebe5f668f781157acb3fb84
treee3cb30bf2f10ec2bbc9a0a130da7a6ee723074f7
parent5cc59c418fde9d02859996707b9d5dfd2941c50b
USB: gadget: udc: fix kernel-doc syntax in file headers

The opening comment mark '/**' is used for highlighting the beginning of
kernel-doc comments.
The header for drivers/usb/gadget/udc/trace files 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.
For e.g., running scripts/kernel-doc -none drivers/usb/gadget/udc/trace.h
emits:
warning: expecting prototype for udc.c(). Prototype was for TRACE_SYSTEM() 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/20210522115227.9977-1-yashsri421@gmail.com
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
drivers/usb/gadget/udc/trace.c
drivers/usb/gadget/udc/trace.h