summaryrefslogtreecommitdiffstats
path: root/include
diff options
context:
space:
mode:
authorRandy Dunlap <rdunlap@xenotime.net>2012-08-18 17:43:05 -0700
committerTakashi Iwai <tiwai@suse.de>2012-08-20 10:26:47 +0200
commit8513915accc611e576dbebb93422c257e7e68be8 (patch)
treef07f3950895214483770aac1395044754297f610 /include
parent94f3ec6b2222eb5c0af0c784f0656ff5b909d870 (diff)
downloadlinux-8513915accc611e576dbebb93422c257e7e68be8.tar.bz2
ALSA: fix pcm.h kernel-doc warning and notation
Fix kernel-doc warning in <sound/pcm.h> and add function name to make the kernel-doc notation complete. Warning(include/sound/pcm.h:1081): No description found for parameter 'substream' Signed-off-by: Randy Dunlap <rdunlap@xenotime.net> Signed-off-by: Takashi Iwai <tiwai@suse.de>
Diffstat (limited to 'include')
-rw-r--r--include/sound/pcm.h3
1 files changed, 2 insertions, 1 deletions
diff --git a/include/sound/pcm.h b/include/sound/pcm.h
index c75c0d1a85e2..cdca2ab1e711 100644
--- a/include/sound/pcm.h
+++ b/include/sound/pcm.h
@@ -1075,7 +1075,8 @@ static inline void snd_pcm_limit_isa_dma_size(int dma, size_t *max)
const char *snd_pcm_format_name(snd_pcm_format_t format);
/**
- * Get a string naming the direction of a stream
+ * snd_pcm_stream_str - Get a string naming the direction of a stream
+ * @substream: the pcm substream instance
*/
static inline const char *snd_pcm_stream_str(struct snd_pcm_substream *substream)
{