[alsa-devel] [PATCH v2] ASoC: Fix kerneldoc errors

Mark Brown broonie at kernel.org
Fri Nov 14 13:57:04 CET 2014


On Mon, Nov 10, 2014 at 09:47:07PM +0100, Takashi Iwai wrote:
> Lots of typos and missing parameter descriptions.
> 
> Some private struct fields are moved to the end of struct and put
> markers to make kerneldoc happy (and it make even easier for human
> readers).

This would've been better split up more.  I've applied it, a couple of
smaller things though:

>  /**
>   * snd_soc_set_ac97_ops_of_reset - Set ac97 ops with generic ac97 reset functions
> + * @ops: AC97 opts to set
> + * @pdev: platform to deal with

It's not a platform, it's a platform device.

>   * snd_soc_dai_set_bclk_ratio - configure BCLK to sample rate ratio.
>   * @dai: DAI
> - * @ratio Ratio of BCLK to Sample rate.
> + * @ratio: Ratio of BCLK to Sample rate.

While you're fixing fixing the capitalization of sample would've been
good.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 473 bytes
Desc: Digital signature
URL: <http://mailman.alsa-project.org/pipermail/alsa-devel/attachments/20141114/3902b337/attachment.sig>


More information about the Alsa-devel mailing list