clk: sunxi: sun9i-cpus: fix kernel-doc warnings
authorRandy Dunlap <rdunlap@infradead.org>
Sun, 21 Jan 2024 05:18:44 +0000 (21:18 -0800)
committerJernej Skrabec <jernej.skrabec@gmail.com>
Tue, 23 Jan 2024 20:47:15 +0000 (21:47 +0100)
commitcc61c9e597bfab555197320e64394b8088c8c44c
treed70ed8cbad16623b45f293caaf8f658139e9b923
parent233d33117f960be6262c170b033b8a8c32c1455a
clk: sunxi: sun9i-cpus: fix kernel-doc warnings

Move the function description kernel-doc comment to immediately above
the function implementation, correct the function name in the comment,
then add a function parameter description to prevent these kernel-doc
warnings:

drivers/clk/sunxi/clk-sun9i-cpus.c:25: warning: expecting prototype for sun9i_a80_cpus_clk_setup(). Prototype was for SUN9I_CPUS_MAX_PARENTS() instead
clk-sun9i-cpus.c:184: warning: Function parameter or struct member 'node' not described in 'sun9i_a80_cpus_setup'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Emilio López <emilio@elopez.com.ar>
Cc: Michael Turquette <mturquette@baylibre.com>
Cc: Stephen Boyd <sboyd@kernel.org>
Cc: <linux-clk@vger.kernel.org>
Cc: Chen-Yu Tsai <wens@csie.org>
Cc: Jernej Skrabec <jernej.skrabec@gmail.com>
Cc: Samuel Holland <samuel@sholland.org>
Cc: <linux-arm-kernel@lists.infradead.org>
Cc: <linux-sunxi@lists.linux.dev>
Reviewed-by: Andre Przywara <andre.przywara@arm.com>
Acked-by: Jernej Skrabec <jernej.skrabec@gmail.com>
Link: https://lore.kernel.org/r/20240121051845.17603-1-rdunlap@infradead.org
Signed-off-by: Jernej Skrabec <jernej.skrabec@gmail.com>
drivers/clk/sunxi/clk-sun9i-cpus.c