soundwire: fix the kernel-doc comment
authorVinod Koul <vkoul@kernel.org>
Wed, 15 Jul 2020 09:57:02 +0000 (15:27 +0530)
committerVinod Koul <vkoul@kernel.org>
Thu, 16 Jul 2020 04:07:43 +0000 (09:37 +0530)
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>
Reviewed-by: Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com>
Link: https://lore.kernel.org/r/20200715095702.1519554-1-vkoul@kernel.org
Signed-off-by: Vinod Koul <vkoul@kernel.org>
drivers/soundwire/stream.c

index 6bc2ff2..37290a7 100644 (file)
@@ -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
  */