[alsa-devel] [PATCH 2/3] ALSA: compress: Fix kernel-doc warnings
Vinod Koul
vinod.koul at intel.com
Tue Nov 15 04:21:32 CET 2016
On Mon, Nov 14, 2016 at 10:30:04PM +0100, Takashi Iwai wrote:
> Some fields in struct snd_compr have no corresponding comments, and
> the kernel-doc complains like:
>
> ./include/sound/compress_driver.h:162: warning: No description found for parameter 'id[64]'
> ./include/sound/compress_driver.h:162: warning: No description found for parameter 'proc_root'
> ./include/sound/compress_driver.h:162: warning: No description found for parameter 'proc_info_entry'
>
> Actually all these are internal elements, just put "private:" comment
> so that they will be ignored.
Acked-by: Vinod Koul <vinod.koul at intel.com>
--
~Vinod
More information about the Alsa-devel
mailing list