From: Vinod Koul <vkoul@kernel.org>
To: alsa-devel@alsa-project.org
Cc: Vinod Koul <vkoul@kernel.org>,
Sanyog Kale <sanyog.r.kale@intel.com>,
Bard Liao <yung-chuan.liao@linux.intel.com>,
Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com>
Subject: [PATCH] soundwire: fix the kernel-doc comment
Date: Wed, 15 Jul 2020 15:27:02 +0530 [thread overview]
Message-ID: <20200715095702.1519554-1-vkoul@kernel.org> (raw)
sdw_startup_stream() and sdw_shutdown_stream() argument has been updated
but not the comments, so update these as well to fix warning with W=1
drivers/soundwire/stream.c:1859: warning: Function parameter or member 'sdw_substream' not described in 'sdw_startup_stream'
drivers/soundwire/stream.c:1859: warning: Excess function parameter 'stream' description in 'sdw_startup_stream'
drivers/soundwire/stream.c:1903: warning: Function parameter or member 'sdw_substream' not described in 'sdw_shutdown_stream'
drivers/soundwire/stream.c:1903: warning: Excess function parameter 'stream' description in 'sdw_shutdown_stream'
Signed-off-by: Vinod Koul <vkoul@kernel.org>
---
drivers/soundwire/stream.c | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/drivers/soundwire/stream.c b/drivers/soundwire/stream.c
index 6bc2ff29c202..37290a799023 100644
--- a/drivers/soundwire/stream.c
+++ b/drivers/soundwire/stream.c
@@ -1851,7 +1851,7 @@ static int set_stream(struct snd_pcm_substream *substream,
/**
* sdw_startup_stream() - Startup SoundWire stream
*
- * @stream: Soundwire stream
+ * @sdw_substream: Soundwire stream
*
* Documentation/driver-api/soundwire/stream.rst explains this API in detail
*/
@@ -1895,7 +1895,7 @@ EXPORT_SYMBOL(sdw_startup_stream);
/**
* sdw_shutdown_stream() - Shutdown SoundWire stream
*
- * @stream: Soundwire stream
+ * @sdw_substream: Soundwire stream
*
* Documentation/driver-api/soundwire/stream.rst explains this API in detail
*/
--
2.26.2
next reply other threads:[~2020-07-15 9:58 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-07-15 9:57 Vinod Koul [this message]
2020-07-15 14:42 ` [PATCH] soundwire: fix the kernel-doc comment Pierre-Louis Bossart
2020-07-16 4:26 ` Vinod Koul
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=20200715095702.1519554-1-vkoul@kernel.org \
--to=vkoul@kernel.org \
--cc=alsa-devel@alsa-project.org \
--cc=pierre-louis.bossart@linux.intel.com \
--cc=sanyog.r.kale@intel.com \
--cc=yung-chuan.liao@linux.intel.com \
/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