| Message ID | 20161114213005.22443-3-tiwai@suse.de (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
On Mon, Nov 14, 2016 at 10:30:04PM +0100, Takashi Iwai wrote: > 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>
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;
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. Signed-off-by: Takashi Iwai <tiwai@suse.de> --- include/sound/compress_driver.h | 1 + 1 file changed, 1 insertion(+)