ARM: OMAP1: 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 arch/arm/mach-omap1/timer.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 OMAP1 Dual(). Prototype was for OMAP1610_GPTIMER1_BASE() 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@gmail.com>
Acked-by: Aaro Koskinen <aaro.koskinen@iki.fi>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Tony Lindgren <tony@atomide.com>
This commit is contained in:
Aditya Srivastava 2021-03-31 02:23:30 +05:30 committed by Tony Lindgren
parent 7c4a0b3e5c
commit 206fa766ca
1 changed files with 1 additions and 1 deletions

View File

@ -1,4 +1,4 @@
/** /*
* OMAP1 Dual-Mode Timers - platform device registration * OMAP1 Dual-Mode Timers - platform device registration
* *
* Contains first level initialization routines which internally * Contains first level initialization routines which internally