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

[Mark Brown]

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).
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 473 bytes
Desc: Digital signature
URL: <http://mailman.alsa-project.org/pipermail/alsa-devel/attachments/20141111/fadf02c0/attachment-0001.sig>