alsa-devel.alsa-project.org archive mirror
 help / color / mirror / Atom feed
* [PATCH] sound: fix pcm.h kernel-doc warning and notation
@ 2012-08-19  0:43 Randy Dunlap
  2012-08-20  8:27 ` Takashi Iwai
  0 siblings, 1 reply; 2+ messages in thread
From: Randy Dunlap @ 2012-08-19  0:43 UTC (permalink / raw)
  To: Takashi Iwai, Jaroslav Kysela, alsa-devel

From: Randy Dunlap <rdunlap@xenotime.net>

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>
Cc:	Jaroslav Kysela <perex@perex.cz>
Cc:	Takashi Iwai <tiwai@suse.de>
Cc:	alsa-devel@alsa-project.org (moderated for non-subscribers)
---
 include/sound/pcm.h |    3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

--- lnx-36-rc2.orig/include/sound/pcm.h
+++ lnx-36-rc2/include/sound/pcm.h
@@ -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)
 {

^ permalink raw reply	[flat|nested] 2+ messages in thread

* Re: [PATCH] sound: fix pcm.h kernel-doc warning and notation
  2012-08-19  0:43 [PATCH] sound: fix pcm.h kernel-doc warning and notation Randy Dunlap
@ 2012-08-20  8:27 ` Takashi Iwai
  0 siblings, 0 replies; 2+ messages in thread
From: Takashi Iwai @ 2012-08-20  8:27 UTC (permalink / raw)
  To: Randy Dunlap; +Cc: alsa-devel

At Sat, 18 Aug 2012 17:43:05 -0700,
Randy Dunlap wrote:
> 
> From: Randy Dunlap <rdunlap@xenotime.net>
> 
> 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>
> Cc:	Jaroslav Kysela <perex@perex.cz>
> Cc:	Takashi Iwai <tiwai@suse.de>
> Cc:	alsa-devel@alsa-project.org (moderated for non-subscribers)

Thanks, applied.


Takashi

> ---
>  include/sound/pcm.h |    3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 
> --- lnx-36-rc2.orig/include/sound/pcm.h
> +++ lnx-36-rc2/include/sound/pcm.h
> @@ -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)
>  {
> 

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2012-08-20  7:57 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2012-08-19  0:43 [PATCH] sound: fix pcm.h kernel-doc warning and notation Randy Dunlap
2012-08-20  8:27 ` Takashi Iwai

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).