clk: sunxi: a20-gmac: fix kernel-doc warnings
authorRandy Dunlap <rdunlap@infradead.org>
Sun, 21 Jan 2024 05:18:35 +0000 (21:18 -0800)
committerJernej Skrabec <jernej.skrabec@gmail.com>
Tue, 23 Jan 2024 20:46:43 +0000 (21:46 +0100)
commit233d33117f960be6262c170b033b8a8c32c1455a
tree7401fe0443d89edc265f71536453d4ab7611842e
parent6613476e225e090cc9aad49be7fa504e290dd33d
clk: sunxi: a20-gmac: fix kernel-doc warnings

Move the function kernel-doc comment to be immediately before the
function implementation, then add a function parameter description
to prevent kernel-doc warnings:

clk-a20-gmac.c:43: warning: expecting prototype for sun7i_a20_gmac_clk_setup(). Prototype was for SUN7I_A20_GMAC_GPIT() instead
clk-a20-gmac.c:53: warning: Function parameter or struct member 'node' not described in 'sun7i_a20_gmac_clk_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/20240121051837.17564-1-rdunlap@infradead.org
Signed-off-by: Jernej Skrabec <jernej.skrabec@gmail.com>
drivers/clk/sunxi/clk-a20-gmac.c