Skip to content

Commit aed6d71

Browse files
rddunlapjernejsk
authored andcommitted
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>
1 parent cc61c9e commit aed6d71

1 file changed

Lines changed: 6 additions & 3 deletions

File tree

drivers/clk/sunxi/clk-usb.c

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,9 +73,6 @@ static const struct reset_control_ops sunxi_usb_reset_ops = {
7373
.deassert = sunxi_usb_reset_deassert,
7474
};
7575

76-
/**
77-
* sunxi_usb_clk_setup() - Setup function for usb gate clocks
78-
*/
7976

8077
#define SUNXI_USB_MAX_SIZE 32
8178

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

85+
/**
86+
* sunxi_usb_clk_setup() - Setup function for usb gate clocks
87+
* @node: &struct device_node for the clock
88+
* @data: &struct usb_clk_data for the clock
89+
* @lock: spinlock for the clock
90+
*/
8891
static void __init sunxi_usb_clk_setup(struct device_node *node,
8992
const struct usb_clk_data *data,
9093
spinlock_t *lock)

0 commit comments

Comments
 (0)