[alsa-devel] [PATCH] sound: fix pcm.h kernel-doc warning and notation

[Takashi Iwai]

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