Add missing kernel-doc for function parameters. Use kernel-doc format for function return value descriptions. Use the "var" keyword to describe a data definition.
These changes avoid all kernel-doc warnings in this file: Warning: ../sound/soc/fsl/mpc5200_psc_i2s.c:123 cannot understand function prototype: 'const struct snd_soc_dai_ops psc_i2s_dai_ops =' Warning: sound/soc/fsl/mpc5200_psc_i2s.c:87 function parameter 'cpu_dai' not described in 'psc_i2s_set_sysclk' Warning: sound/soc/fsl/mpc5200_psc_i2s.c:87 No description found for return value of 'psc_i2s_set_sysclk' Warning: sound/soc/fsl/mpc5200_psc_i2s.c:106 function parameter 'cpu_dai' not described in 'psc_i2s_set_fmt' Warning: sound/soc/fsl/mpc5200_psc_i2s.c:106 No description found for return value of 'psc_i2s_set_fmt' Warning: sound/soc/fsl/mpc5200_psc_i2s.c:123 cannot understand function prototype: 'const struct snd_soc_dai_ops psc_i2s_dai_ops =' Signed-off-by: Randy Dunlap <[email protected]> --- v2: no change Cc: Liam Girdwood <[email protected]> Cc: Mark Brown <[email protected]> Cc: [email protected] Cc: Shengjiu Wang <[email protected]> Cc: Xiubo Li <[email protected]> Cc: Fabio Estevam <[email protected]> Cc: Nicolin Chen <[email protected]> Cc: [email protected] sound/soc/fsl/mpc5200_psc_i2s.c | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) --- linext-2026-0710.orig/sound/soc/fsl/mpc5200_psc_i2s.c +++ linext-2026-0710/sound/soc/fsl/mpc5200_psc_i2s.c @@ -79,9 +79,12 @@ static int psc_i2s_hw_params(struct snd_ * and we don't care about the frequency. Return an error if the direction * is not SND_SOC_CLOCK_IN. * + * @cpu_dai: DAI runtime data pointer * @clk_id: reserved, should be zero * @freq: the frequency of the given clock ID, currently ignored * @dir: SND_SOC_CLOCK_IN (clock slave) or SND_SOC_CLOCK_OUT (clock master) + * + * Returns: %0 on success or %-EINVAL on failure. */ static int psc_i2s_set_sysclk(struct snd_soc_dai *cpu_dai, int clk_id, unsigned int freq, int dir) @@ -101,7 +104,10 @@ static int psc_i2s_set_sysclk(struct snd * This driver only supports I2S mode. Return an error if the format is * not SND_SOC_DAIFMT_I2S. * + * @cpu_dai: DAI runtime data pointer * @format: one of SND_SOC_DAIFMT_xxx + * + * Returns: %0 on success or %-EINVAL on failure. */ static int psc_i2s_set_fmt(struct snd_soc_dai *cpu_dai, unsigned int format) { @@ -119,7 +125,7 @@ static int psc_i2s_set_fmt(struct snd_so */ /** - * psc_i2s_dai_template: template CPU Digital Audio Interface + * var psc_i2s_dai_ops - template CPU Digital Audio Interface */ static const struct snd_soc_dai_ops psc_i2s_dai_ops = { .hw_params = psc_i2s_hw_params,
