Skip to contentSkip to conversation

sound: fix pcm.h kernel-doc warning and notation

PATCH Applied Randy Dunlap 2 participants 2 messages Aug 19, 2012 – Aug 20, 2012 Sound

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 sound: fix pcm.h kernel-doc warning and notation

From: Randy Dunlap <[email protected]>

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'

Cc Jaroslav Kysela <[email protected]>
Cc Takashi Iwai <[email protected]>
Cc [email protected] (moderated for non-subscribers)
---
 include/sound/pcm.h |    3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
include/sound/pcm.h +2 -1
@@ -1075,7 +1075,8 @@ static inline void snd_pcm_limit_isa_dma
 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)
 {
Applied
#1 lore raw

At Sat, 18 Aug 2012 17:43:05 -0700,

Quoted 6 lines · Randy Dunlap

From: Randy Dunlap <[email protected]>

Fix kernel-doc warning in <sound/pcm.h> and add function name to make the kernel-doc notation complete.

Quoted 6 lines

Warning(include/sound/pcm.h:1081): No description found for parameter 'substream'

Cc Jaroslav Kysela <[email protected]>
Cc Takashi Iwai <[email protected]>
Cc [email protected] (moderated for non-subscribers)

Thanks, applied.

Takashi

Quoted 17 lines
---
 include/sound/pcm.h |    3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
include/sound/pcm.h +2 -1
@@ -1075,7 +1075,8 @@ static inline void snd_pcm_limit_isa_dma
 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)
 {