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

[Takashi Iwai]

At Tue, 11 Nov 2014 00:32:05 +0000,
Mark Brown wrote:
> 
> On Mon, Nov 10, 2014 at 09:45:26PM +0100, Takashi Iwai wrote:
> > Mark Brown wrote:
> 
> > > > 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.
> 
> I totally agree that someone should do that work :)
> 
> > > 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.
> 
> Right, and I am enforcing that for new stuff.  Since we don't currently
> generate linuxdoc outputs we don't currently get any warnings and I'm
> not seeing much demand for the actual outputs (as opposed to the
> comments in the code which are useful; AFAICT that's the way most people
> consume linuxdoc).

We do generate linuxdoc outputs for 3.19 :)

That's why I've been working on fixing the issues.


Takashi