Re: [PATCH 3/4] ALSA: mixart: Fix kerneldoc comments

From: Takashi Iwai <tiwai@suse.de>
To: Peter Meerwald <pmeerw@pmeerw.net>
Cc: alsa-devel@alsa-project.org
Subject: Re: [PATCH 3/4] ALSA: mixart: Fix kerneldoc comments
Date: Mon, 10 Nov 2014 18:04:25 +0100	[thread overview]
Message-ID: <s5hwq73ng12.wl-tiwai@suse.de> (raw)
In-Reply-To: <alpine.DEB.2.02.1411101758540.18642@pmeerw.net>

At Mon, 10 Nov 2014 18:00:28 +0100 (CET),
Peter Meerwald wrote:
> 
> 
> > Signed-off-by: Takashi Iwai <tiwai@suse.de>
> > ---
> >  sound/pci/mixart/mixart_hwdep.c | 9 +++++----
> >  1 file changed, 5 insertions(+), 4 deletions(-)
> > 
> > diff --git a/sound/pci/mixart/mixart_hwdep.c b/sound/pci/mixart/mixart_hwdep.c
> > index 581e1e74863c..9996a4dead0f 100644
> > --- a/sound/pci/mixart/mixart_hwdep.c
> > +++ b/sound/pci/mixart/mixart_hwdep.c
> > @@ -37,10 +37,11 @@
> >  /**
> >   * wait for a value on a peudo register, exit with a timeout
> >   *
> > - * @param mgr pointer to miXart manager structure
> > - * @param offset unsigned pseudo_register base + offset of value
> > - * @param value value
> > - * @param timeout timeout in centisenconds
> > + * @mgr: pointer to miXart manager structure
> > + * @offset: unsigned pseudo_register base + offset of value
> > + * @is_egal: wait for the equal value
> > + * @value: value
> > + * @timeout: timeout in centisenconds
> >   */
> >  static int mixart_wait_nice_for_register_value(struct mixart_mgr *mgr,
> >  					       u32 offset, int is_egal,
> 
> centiseconds
> 
> looks like is_egal should be named is_equal?

Yes, but the important bit of this patch series is touching only
comments.  This guarantees not to break anything.

(And honestly speaking, I don't care.  It can be even a good chance
 for readers to learn French or German :)

Takashi