[alsa-devel] [PATCH] ASoC: Fix kerneldoc errors

[Takashi Iwai]

At Mon, 10 Nov 2014 19:58:02 +0000,
Mark Brown wrote:
> 
> On Mon, Nov 10, 2014 at 08:26:45PM +0100, Takashi Iwai wrote:
> > Mark Brown wrote:
> 
> > > If we are going to do this sort of stuff and have people looking at the
> > > output I'd prefer that we did do those annotations (and move things
> > > around).  This just happened to be the first change in the diff but I'd
> > > guess there may be some other things that are undocumented because
> > > people aren't supposed to be looking at them (as well as ones that were
> > > just missed).
> 
> > I don't mind in which ways.  Showing and hiding have both pros and
> > cons.  Please just fix your code before I pull for 3.19!
> 
> Well, I think someone who cares should fix it!  :P

Heh, *we* agreed on fixing / enhancing documentation in the previous
meeting.

> More seriously it's on the list but I'm having a hard time seeing it as
> being super urgent - it's more in the nice to have range for me.

Well, I see this a bit differently.  As discussed, we should be really
more strict on documentation.  From now on, any new API function and
struct should mandate kerneldoc comments.  At least, I'll watch out in
the future pull request and patch reviews.  And, fixing these trivial
kerneldoc makes things a bit easier; otherwise the new warnings will
be buried in other old warnings.

In anyway, I'll send a v2 patch soon later.


Takashi