From: Takashi Iwai <tiwai@suse.de>
Date: Mon, 14 Nov 2016 21:22:27 +0000 (+0100)
Subject: ALSA: compress: Fix kernel-doc warnings
X-Git-Tag: rel_imx_4.19.35_1.1.0~13556^2~19
X-Git-Url: https://git.somdevices.com/?a=commitdiff_plain;h=f84551e45fd72a248ee69a5b95383b0334a2faac;p=linux.git

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>
---

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;