From: Takashi Iwai <tiwai@suse.de>
To: alsa-devel@alsa-project.org
Subject: [PATCH 2/3] ALSA: compress: Fix kernel-doc warnings
Date: Mon, 14 Nov 2016 22:30:04 +0100 [thread overview]
Message-ID: <20161114213005.22443-3-tiwai@suse.de> (raw)
In-Reply-To: <20161114213005.22443-1-tiwai@suse.de>
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(+)
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;
--
2.10.2
next prev parent reply other threads:[~2016-11-14 21:30 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-11-14 21:30 [PATCH 0/3] Trivial kernel-doc fixes Takashi Iwai
2016-11-14 21:30 ` [PATCH 1/3] ALSA: ac97: Fix kernel-doc error with sphinx formatter Takashi Iwai
2016-11-14 21:30 ` Takashi Iwai [this message]
2016-11-15 3:21 ` [PATCH 2/3] ALSA: compress: Fix kernel-doc warnings Vinod Koul
2016-11-14 21:30 ` [PATCH 3/3] ALSA: core: " Takashi Iwai
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20161114213005.22443-3-tiwai@suse.de \
--to=tiwai@suse.de \
--cc=alsa-devel@alsa-project.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox