[PATCH] usb: dwc3: imx8mp: fix incorrect kernel-doc comment syntax

Fabio Estevam festevam at gmail.com
Mon Mar 29 16:43:44 UTC 2021

Hi Aditya,

On Mon, Mar 29, 2021 at 11:26 AM Aditya Srivastava <yashsri421 at gmail.com> wrote:
> The opening comment mark '/**' is used for highlighting the beginning of
> kernel-doc comments.
> The header for drivers/usb/dwc3/dwc3-imx8mp.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 USB_WAKEUP_CTRL() instead"
> Provide a simple fix by replacing this occurrence with general comment
> format, i.e. '/*', to prevent kernel-doc from parsing it.
> Signed-off-by: Aditya Srivastava <yashsri421 at gmail.com>

It looks good, thanks:

Reviewed-by: Fabio Estevam <festevam at gmail.com>

More information about the Linux-kernel-mentees mailing list