diff options
| author | Takashi Iwai <tiwai@suse.de> | 2016-11-14 22:22:27 +0100 |
|---|---|---|
| committer | Takashi Iwai <tiwai@suse.de> | 2016-11-15 07:28:15 +0100 |
| commit | f84551e45fd72a248ee69a5b95383b0334a2faac (patch) | |
| tree | cc8240f6155d6e639c2fff08fff7dd6b4f6947a2 /include/sound/compress_driver.h | |
| parent | ALSA: ac97: Fix kernel-doc error with sphinx formatter (diff) | |
| download | linux-f84551e45fd72a248ee69a5b95383b0334a2faac.tar.xz linux-f84551e45fd72a248ee69a5b95383b0334a2faac.zip | |
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>
Diffstat (limited to 'include/sound/compress_driver.h')
| -rw-r--r-- | include/sound/compress_driver.h | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/include/sound/compress_driver.h b/include/sound/compress_driver.h index cee8c00f3d3e..9924bc9cbc7c 100644 --- a/include/sound/compress_driver.h +++ b/include/sound/compress_driver.h @@ -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; |