ALSA: compress: Fix kernel-doc warnings
authorTakashi Iwai <tiwai@suse.de>
Mon, 14 Nov 2016 21:22:27 +0000 (22:22 +0100)
committerTakashi Iwai <tiwai@suse.de>
Tue, 15 Nov 2016 06:28:15 +0000 (07:28 +0100)
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>
include/sound/compress_driver.h

index cee8c00..9924bc9 100644 (file)
@@ -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;