Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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: Vinod Koul <vinod.koul@intel.com>
Signed-off-by: Takashi Iwai <tiwai@suse.de>

+1
+1
include/sound/compress_driver.h
··· 155 155 struct mutex lock; 156 156 int device; 157 157 #ifdef CONFIG_SND_VERBOSE_PROCFS 158 + /* private: */ 158 159 char id[64]; 159 160 struct snd_info_entry *proc_root; 160 161 struct snd_info_entry *proc_info_entry;