Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

clk: qcom: clk-alpha-pll: fix kerneldoc of struct clk_alpha_pll

Add missing descriptions of the 'num_vco' and 'flags' members to
clk_alpha_pll structure's documentation. Also reorder the member
description entries to match the order of the declarations.

Eliminates the following warnings:
drivers/clk/qcom/clk-alpha-pll.h:72: info: Scanning doc for struct clk_alpha_pll
drivers/clk/qcom/clk-alpha-pll.h:91: warning: Function parameter or struct member 'num_vco' not described in 'clk_alpha_pll'
drivers/clk/qcom/clk-alpha-pll.h:91: warning: Function parameter or struct member 'flags' not described in 'clk_alpha_pll'

No functional changes.

Signed-off-by: Gabor Juhos <j4g8y7@gmail.com>
Reviewed-by: Dmitry Baryshkov <dmitry.baryshkov@linaro.org>
Link: https://lore.kernel.org/r/20240321-alpha-pll-kerneldoc-v1-1-0d76926b72c3@gmail.com
Signed-off-by: Bjorn Andersson <andersson@kernel.org>

authored by

Gabor Juhos and committed by
Bjorn Andersson
3b985489 8c48466c

+3 -1
+3 -1
drivers/clk/qcom/clk-alpha-pll.h
··· 73 73 /** 74 74 * struct clk_alpha_pll - phase locked loop (PLL) 75 75 * @offset: base address of registers 76 - * @vco_table: array of VCO settings 77 76 * @regs: alpha pll register map (see @clk_alpha_pll_regs) 77 + * @vco_table: array of VCO settings 78 + * @num_vco: number of VCO settings in @vco_table 79 + * @flags: bitmask to indicate features supported by the hardware 78 80 * @clkr: regmap clock handle 79 81 */ 80 82 struct clk_alpha_pll {