soc: fsl: guts: fix comment syntax in file
authorAditya Srivastava <yashsri421@gmail.com>
Sun, 14 Mar 2021 07:28:28 +0000 (12:58 +0530)
committerLi Yang <leoyang.li@nxp.com>
Tue, 6 Apr 2021 20:33:32 +0000 (15:33 -0500)
commitdc67dac617e3586ec2db49f3c4fde1d6ac7afe14
treea599145a758db5267845c6e74436ba2c3ee9e30f
parent9469f04bb9e69e437941c52f0802284e5d3fa4bc
soc: fsl: guts: fix comment syntax in file

The opening comment mark '/**' is used for kernel-doc comments.
There are certain comments in include/linux/fsl/guts.h which follows this
syntax, but the content inside does not comply with kernel-doc.

E.g., opening comment for "Freecale 85xx and 86xx Global Utilties
register set" follows kernel-doc syntax(i.e., '/**'), but the content
inside does not comply with any kernel-doc specification (function,
struct, etc).

This causes unwelcomed warning from kernel-doc:
"warning: expecting prototype for Freecale 85xx and 86xx Global Utilties register set(). Prototype was for __FSL_GUTS_H__() instead"

Replace all such comment occurrences with general comment format,
i.e. '/*' to pervent kernel-doc from parsing these.

Signed-off-by: Aditya Srivastava <yashsri421@gmail.com>
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Li Yang <leoyang.li@nxp.com>
include/linux/fsl/guts.h