From: Takashi Iwai Subject: Re: [PATCH] sound: fix pcm.h kernel-doc warning and notation Date: Mon, 20 Aug 2012 10:27:03 +0200 Message-ID: References: <50303699.8030309@xenotime.net> Mime-Version: 1.0 (generated by SEMI 1.14.6 - "Maruoka") Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Return-path: Received: from mx2.suse.de (cantor2.suse.de [195.135.220.15]) by alsa0.perex.cz (Postfix) with ESMTP id 1ECBC265D4C for ; Mon, 20 Aug 2012 09:57:18 +0200 (CEST) In-Reply-To: <50303699.8030309@xenotime.net> List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: alsa-devel-bounces@alsa-project.org Sender: alsa-devel-bounces@alsa-project.org To: Randy Dunlap Cc: alsa-devel@alsa-project.org List-Id: alsa-devel@alsa-project.org At Sat, 18 Aug 2012 17:43:05 -0700, Randy Dunlap wrote: > > From: Randy Dunlap > > Fix kernel-doc warning in 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 > Cc: Jaroslav Kysela > Cc: Takashi Iwai > 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) > { >