ARM: OMAP2+: fix incorrect kernel-doc comment syntax in file
authorAditya Srivastava <yashsri421@gmail.com>
Tue, 30 Mar 2021 20:59:08 +0000 (02:29 +0530)
committerTony Lindgren <tony@atomide.com>
Wed, 31 Mar 2021 06:04:22 +0000 (09:04 +0300)
The opening comment mark '/**' is used for highlighting the beginning of
kernel-doc comments.
The header for arch/arm/mach-omap2/omap_twl.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: wrong kernel-doc identifier on line:
 * OMAP and TWL PMIC specific initializations."

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@gmail.com>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Tony Lindgren <tony@atomide.com>
arch/arm/mach-omap2/omap_twl.c

index a642d3b39e503ec4878ab2364520480e52ca24e6..d4dab041324dc035e5ccc27b51781499c08ee5b5 100644 (file)
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: GPL-2.0-only
-/**
+/*
  * OMAP and TWL PMIC specific initializations.
  *
  * Copyright (C) 2010 Texas Instruments Incorporated.