linux-kernel - RE: [PATCH 03/11] ASoC: codecs: da7210: fix kernel-doc

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Date:   Fri, 3 Jul 2020 09:22:22 +0000
From:   Adam Thomson <Adam.Thomson.Opensource@...semi.com>
To:     Pierre-Louis Bossart <pierre-louis.bossart@...ux.intel.com>,
        "alsa-devel@...a-project.org" <alsa-devel@...a-project.org>
CC:     "tiwai@...e.de" <tiwai@...e.de>,
        "broonie@...nel.org" <broonie@...nel.org>,
        Support Opensource <Support.Opensource@...semi.com>,
        Liam Girdwood <lgirdwood@...il.com>,
        Jaroslav Kysela <perex@...ex.cz>,
        Takashi Iwai <tiwai@...e.com>,
        open list <linux-kernel@...r.kernel.org>
Subject: RE: [PATCH 03/11] ASoC: codecs: da7210: fix kernel-doc

On 01 July 2020 19:24, Pierre-Louis Bossart wrote:

> Fix W=1 warning, the kernel-doc syntax was probably from Doxygen?
> 
> Signed-off-by: Pierre-Louis Bossart <pierre-louis.bossart@...ux.intel.com>

So is the issue that the Kernel warning mechanism doesn't like Doxygen syntax?
If so then:

Acked-by: Adam Thomson <Adam.Thomson.Opensource@...semi.com>

> ---
>  sound/soc/codecs/da7210.c | 12 +++++++-----
>  1 file changed, 7 insertions(+), 5 deletions(-)
> 
> diff --git a/sound/soc/codecs/da7210.c b/sound/soc/codecs/da7210.c
> index 0c99dcf242e4..2bb727dd3a20 100644
> --- a/sound/soc/codecs/da7210.c
> +++ b/sound/soc/codecs/da7210.c
> @@ -971,14 +971,16 @@ static int da7210_set_dai_sysclk(struct snd_soc_dai
> *codec_dai,
> 
>  /**
>   * da7210_set_dai_pll	:Configure the codec PLL
> - * @param codec_dai	: pointer to codec DAI
> - * @param pll_id	: da7210 has only one pll, so pll_id is always zero
> - * @param fref		: MCLK frequency, should be < 20MHz
> - * @param fout		: FsDM value, Refer page 44 & 45 of datasheet
> - * @return int		: Zero for success, negative error code for error
> + * @codec_dai: pointer to codec DAI
> + * @pll_id: da7210 has only one pll, so pll_id is always zero
> + * @source: clock source
> + * @fref: MCLK frequency, should be < 20MHz
> + * @fout: FsDM value, Refer page 44 & 45 of datasheet
>   *
>   * Note: Supported PLL input frequencies are 12MHz, 13MHz, 13.5MHz, 14.4MHz,
>   *       19.2MHz, 19.6MHz and 19.8MHz
> + *
> + * Return: Zero for success, negative error code for error
>   */
>  static int da7210_set_dai_pll(struct snd_soc_dai *codec_dai, int pll_id,
>  			      int source, unsigned int fref, unsigned int fout)
> --
> 2.25.1