clk: imx: pllv1: fix kernel-doc notation for struct clk_pllv1
authorRandy Dunlap <rdunlap@infradead.org>
Mon, 15 Nov 2021 03:26:07 +0000 (19:26 -0800)
committerStephen Boyd <sboyd@kernel.org>
Fri, 3 Dec 2021 01:26:40 +0000 (17:26 -0800)
commit71e762316140445c3146bac98ffb29ad6ea0d36c
tree10b151f3cdd344a2356eed1f7d1025d95e69b183
parentfa55b7dcdc43c1aa1ba12bca9d2dd4318c2a0dbf
clk: imx: pllv1: fix kernel-doc notation for struct clk_pllv1

Convert struct clk_pllv1 comments to kernel-doc notation and move them
below the MFN_* macros.

Fixes this kernel-doc warning:

drivers/clk/imx/clk-pllv1.c:12: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * pll v1

Fixes: 2af9e6db14db ("ARM i.MX: Add common clock support for pllv1")
Fixes: a594790368a8 ("ARM: imx: pllv1: Fix PLL calculation for i.MX27")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Reported-by: kernel test robot <lkp@intel.com>
Cc: Abel Vesa <abel.vesa@nxp.com>
Cc: linux-clk@vger.kernel.org
Cc: linux-imx@nxp.com
Cc: Alexander Shiyan <shc_work@mail.ru>
Cc: Shawn Guo <shawn.guo@linaro.org>
Cc: Sascha Hauer <s.hauer@pengutronix.de>
Link: https://lore.kernel.org/r/20211115032607.28970-1-rdunlap@infradead.org
Signed-off-by: Stephen Boyd <sboyd@kernel.org>
drivers/clk/imx/clk-pllv1.c