[03/11] ASoC: codecs: da7210: fix kernel-doc
diff mbox series

Message ID 20200701182422.81496-4-pierre-louis.bossart@linux.intel.com
State New
Headers show
Series
  • ASoC: codecs: fix kernel-doc and W=1 warnings
Related show

Commit Message

Pierre-Louis Bossart July 1, 2020, 6:24 p.m. UTC
Fix W=1 warning, the kernel-doc syntax was probably from Doxygen?

Signed-off-by: Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com>
---
 sound/soc/codecs/da7210.c | 12 +++++++-----
 1 file changed, 7 insertions(+), 5 deletions(-)

Comments

Adam Thomson July 3, 2020, 9:22 a.m. UTC | #1
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@linux.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@diasemi.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

Patch
diff mbox series

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)