[alsa-devel] Kerneldoc warnings in ASoC source codes

[Takashi Iwai]

Hi,

I tried to process kerneldoc to sound/soc/soc-*.c and
include/sound/soc.h, and hit quite lots of warnings.  Many of them are
trivial, typos, but some are unclear.

I Cc'ed relevant people: could you guys fix these properly for 3.19
kernel?

FYI, you can get the errors, e.g.
	scripts/kernel-doc sound/soc/soc-core.c > /dev/null


thanks,

Takashi

Warning(.//include/sound/soc.h:595): No description found for parameter 'list'
Warning(.//include/sound/soc.h:613): No description found for parameter 'list'
Warning(.//include/sound/soc.h:648): No description found for parameter 'gpiod_dev'
Warning(.//include/sound/soc.h:648): No description found for parameter 'debounce_time'
Warning(.//include/sound/soc.h:648): No description found for parameter 'jack'
Warning(.//include/sound/soc.h:648): No description found for parameter 'work'
Warning(.//include/sound/soc.h:648): No description found for parameter 'desc'
Warning(.//include/sound/soc.h:648): No description found for parameter 'data'
Warning(.//include/sound/soc.h:648): Excess struct/union/enum/typedef member 'debouce_time' description in 'snd_soc_jack_gpio'
Warning(.//sound/soc/soc-core.c:2122): No description found for parameter 'ops'
Warning(.//sound/soc/soc-core.c:2122): No description found for parameter 'pdev'
Warning(.//sound/soc/soc-core.c:2696): No description found for parameter 'ucontrol'
Warning(.//sound/soc/soc-core.c:2696): Excess function parameter 'uinfo' description in 'snd_soc_put_volsw_sx'
Warning(.//sound/soc/soc-core.c:3466): No description found for parameter 'ratio'
Warning(.//sound/soc/soc-core.c:4088): No description found for parameter 'dev'
Warning(.//sound/soc/soc-core.c:4126): No description found for parameter 'platform_drv'
Warning(.//sound/soc/soc-core.c:4126): Excess function parameter 'platform_driver' description in 'snd_soc_add_platform'
Warning(.//sound/soc/soc-core.c:4165): No description found for parameter 'dev'
Warning(.//sound/soc/soc-core.c:4165): No description found for parameter 'platform_drv'
Warning(.//sound/soc/soc-core.c:4165): Excess function parameter 'platform' description in 'snd_soc_register_platform'
Warning(.//sound/soc/soc-core.c:4221): No description found for parameter 'dev'
Warning(.//sound/soc/soc-core.c:4221): Excess function parameter 'platform' description in 'snd_soc_unregister_platform'
Warning(.//sound/soc/soc-core.c:4315): No description found for parameter 'dev'
Warning(.//sound/soc/soc-core.c:4315): No description found for parameter 'codec_drv'
Warning(.//sound/soc/soc-core.c:4315): No description found for parameter 'dai_drv'
Warning(.//sound/soc/soc-core.c:4315): No description found for parameter 'num_dai'
Warning(.//sound/soc/soc-core.c:4315): Excess function parameter 'codec' description in 'snd_soc_register_codec'
Warning(.//sound/soc/soc-core.c:4412): No description found for parameter 'dev'
Warning(.//sound/soc/soc-core.c:4412): Excess function parameter 'codec' description in 'snd_soc_unregister_codec'
Warning(.//sound/soc/soc-devres.c:70): No description found for parameter 'platform_drv'
Warning(.//sound/soc/soc-devres.c:70): Excess function parameter 'platform' description in 'devm_snd_soc_register_platform'
Warning(.//sound/soc/soc-dapm.c:2690): No description found for parameter 'card'
Warning(.//sound/soc/soc-dapm.c:2690): Excess function parameter 'dapm' description in 'snd_soc_dapm_new_widgets'
Warning(.//sound/soc/soc-jack.c:126): No description found for parameter 'zones'
Warning(.//sound/soc/soc-jack.c:126): Excess function parameter 'zone' description in 'snd_soc_jack_add_zones'