Commit aed6d713 authored Jan 20, 2024 by Randy Dunlap Committed by Jernej Skrabec Jan 23, 2024

clk: sunxi: usb: fix kernel-doc warnings



Move the function description comment to immediately above the
function implementation, the add function parameter descriptions to
prevent kernel-doc warnings:

clk-usb.c:80: warning: expecting prototype for sunxi_usb_clk_setup(). Prototype was for SUNXI_USB_MAX_SIZE() instead
clk-usb.c:91: warning: Function parameter or struct member 'node' not described in 'sunxi_usb_clk_setup'
clk-usb.c:91: warning: Function parameter or struct member 'data' not described in 'sunxi_usb_clk_setup'
clk-usb.c:91: warning: Function parameter or struct member 'lock' not described in 'sunxi_usb_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/20240121051858.17647-1-rdunlap@infradead.org


Signed-off-by: Jernej Skrabec <jernej.skrabec@gmail.com>

parent cc61c9e5

drivers/clk/sunxi/clk-usb.c

+6 −3

Original line number	Diff line number	Diff line
		@@ -73,9 +73,6 @@ static const struct reset_control_ops sunxi_usb_reset_ops = {
		.deassert = sunxi_usb_reset_deassert,
		};

		/**
		* sunxi_usb_clk_setup() - Setup function for usb gate clocks
		*/

		#define SUNXI_USB_MAX_SIZE 32

		@@ -85,6 +82,12 @@ struct usb_clk_data {
		bool reset_needs_clk;
		};

		/**
		* sunxi_usb_clk_setup() - Setup function for usb gate clocks
		* @node: &struct device_node for the clock
		* @data: &struct usb_clk_data for the clock
		* @lock: spinlock for the clock
		*/
		static void __init sunxi_usb_clk_setup(struct device_node *node,
		const struct usb_clk_data *data,
		spinlock_t *lock)