Re: [PATCH] clk: sunxi: usb: fix kernel-doc warnings

[Andre Przywara]

On Sat, 20 Jan 2024 21:18:57 -0800
Randy Dunlap <rdunlap@xxxxxxxxxxxxx> wrote:

> 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'

Reviewed-by: Andre Przywara <andre.przywara@xxxxxxx>

Cheers,
Andre

> Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
> Cc: Emilio López <emilio@xxxxxxxxxxxxx>
> Cc: Michael Turquette <mturquette@xxxxxxxxxxxx>
> Cc: Stephen Boyd <sboyd@xxxxxxxxxx>
> Cc: linux-clk@xxxxxxxxxxxxxxx
> Cc: Chen-Yu Tsai <wens@xxxxxxxx>
> Cc: Jernej Skrabec <jernej.skrabec@xxxxxxxxx>
> Cc: Samuel Holland <samuel@xxxxxxxxxxxx>
> Cc: linux-arm-kernel@xxxxxxxxxxxxxxxxxxx
> Cc: linux-sunxi@xxxxxxxxxxxxxxx
> ---
>  drivers/clk/sunxi/clk-usb.c |    9 ++++++---
>  1 file changed, 6 insertions(+), 3 deletions(-)
> 
> diff -- a/drivers/clk/sunxi/clk-usb.c b/drivers/clk/sunxi/clk-usb.c
> --- a/drivers/clk/sunxi/clk-usb.c
> +++ b/drivers/clk/sunxi/clk-usb.c
> @@ -73,9 +73,6 @@ static const struct reset_control_ops su
>  	.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)
>