| Message ID | 20240321-alpha-pll-kerneldoc-v1-1-0d76926b72c3@gmail.com (mailing list archive) |
|---|---|
| State | Awaiting Upstream, archived |
| Headers | show |
| Series | clk: qcom: clk-alpha-pll: fix kerneldoc of struct clk_alpha_pll | expand |
On Thu, 21 Mar 2024 at 10:59, Gabor Juhos <j4g8y7@gmail.com> wrote: > > 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> > --- > Based on v6.8. > --- > drivers/clk/qcom/clk-alpha-pll.h | 4 +++- > 1 file changed, 3 insertions(+), 1 deletion(-) Reviewed-by: Dmitry Baryshkov <dmitry.baryshkov@linaro.org>
On Thu, 21 Mar 2024 09:59:04 +0100, Gabor Juhos wrote: > 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' > > [...] Applied, thanks! [1/1] clk: qcom: clk-alpha-pll: fix kerneldoc of struct clk_alpha_pll commit: 3b985489178cfb545118bd4dbefb6311f4bbfcf2 Best regards,
diff --git a/drivers/clk/qcom/clk-alpha-pll.h b/drivers/clk/qcom/clk-alpha-pll.h index a1a75bb12fe88..19717246c8b6e 100644 --- a/drivers/clk/qcom/clk-alpha-pll.h +++ b/drivers/clk/qcom/clk-alpha-pll.h @@ -71,8 +71,10 @@ struct pll_vco { /** * struct clk_alpha_pll - phase locked loop (PLL) * @offset: base address of registers - * @vco_table: array of VCO settings * @regs: alpha pll register map (see @clk_alpha_pll_regs) + * @vco_table: array of VCO settings + * @num_vco: number of VCO settings in @vco_table + * @flags: bitmask to indicate features supported by the hardware * @clkr: regmap clock handle */ 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> --- Based on v6.8. --- drivers/clk/qcom/clk-alpha-pll.h | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) --- base-commit: e8f897f4afef0031fe618a8e94127a0934896aba change-id: 20240321-alpha-pll-kerneldoc-f75060034495 Best regards,