]> git.proxmox.com Git - mirror_ubuntu-zesty-kernel.git/commit
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)
commitf84551e45fd72a248ee69a5b95383b0334a2faac
treecc8240f6155d6e639c2fff08fff7dd6b4f6947a2
parent1936f00424d142c596e7d4af06a78b830a9ed62b
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>
include/sound/compress_driver.h