[PATCH v2 07/28] ASoC: fsl: fsl_spdif: Use correct formatting when denoting struct documentation

Lee Jones lee.jones at linaro.org
Wed Jul 8 00:37:21 AEST 2020


Kerneldoc expects struct documentation to start with "struct $NAME".

Fixes the following W=1 kernel build warning(s):

 sound/soc/fsl/fsl_spdif.c:104: warning: cannot understand function prototype: 'struct fsl_spdif_priv '

Cc: Timur Tabi <timur at kernel.org>
Cc: Nicolin Chen <nicoleotsuka at gmail.com>
Cc: Xiubo Li <Xiubo.Lee at gmail.com>
Cc: Fabio Estevam <festevam at gmail.com>
Cc: Vladimir Barinov <vbarinov at embeddedalley.com>
Cc: linuxppc-dev at lists.ozlabs.org
Signed-off-by: Lee Jones <lee.jones at linaro.org>
---
 sound/soc/fsl/fsl_spdif.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/sound/soc/fsl/fsl_spdif.c b/sound/soc/fsl/fsl_spdif.c
index 5b2689ae63d4d..7aa3bdec5b6b5 100644
--- a/sound/soc/fsl/fsl_spdif.c
+++ b/sound/soc/fsl/fsl_spdif.c
@@ -81,7 +81,7 @@ struct spdif_mixer_control {
 };
 
 /**
- * fsl_spdif_priv: Freescale SPDIF private data
+ * struct fsl_spdif_priv - Freescale SPDIF private data
  *
  * @fsl_spdif_control: SPDIF control data
  * @cpu_dai_drv: cpu dai driver
-- 
2.25.1



More information about the Linuxppc-dev mailing list