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

[Andre Przywara]

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

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

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-sun9i-cpus.c |    7 ++++---
>  1 file changed, 4 insertions(+), 3 deletions(-)
> 
> diff -- a/drivers/clk/sunxi/clk-sun9i-cpus.c b/drivers/clk/sunxi/clk-sun9i-cpus.c
> --- a/drivers/clk/sunxi/clk-sun9i-cpus.c
> +++ b/drivers/clk/sunxi/clk-sun9i-cpus.c
> @@ -18,9 +18,6 @@
>  
>  static DEFINE_SPINLOCK(sun9i_a80_cpus_lock);
>  
> -/**
> - * sun9i_a80_cpus_clk_setup() - Setup function for a80 cpus composite clk
> - */
>  
>  #define SUN9I_CPUS_MAX_PARENTS		4
>  #define SUN9I_CPUS_MUX_PARENT_PLL4	3
> @@ -180,6 +177,10 @@ static const struct clk_ops sun9i_a80_cp
>  	.set_rate	= sun9i_a80_cpus_clk_set_rate,
>  };
>  
> +/**
> + * sun9i_a80_cpus_setup() - Setup function for a80 cpus composite clk
> + * @node: &struct device_node for the clock
> + */
>  static void sun9i_a80_cpus_setup(struct device_node *node)
>  {
>  	const char *clk_name = node->name;
>