Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit f84551e4 authored by Takashi Iwai's avatar Takashi Iwai
Browse files

ALSA: compress: Fix kernel-doc warnings 



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: default avatarVinod Koul <vinod.koul@intel.com>
Signed-off-by: default avatarTakashi Iwai <tiwai@suse.de>
parent 1936f004

include/sound/compress_driver.h

+1 −0
Original line number Diff line number Diff line
@@ -155,6 +155,7 @@ struct snd_compr { 
	struct mutex lock;

	int device;

#ifdef CONFIG_SND_VERBOSE_PROCFS

	/* private: */

	char id[64];

	struct snd_info_entry *proc_root;

	struct snd_info_entry *proc_info_entry;