Re: [PATCH] scripts/kernel-doc Allow struct arguments documentation in struct body

Laurent Pinchart
2015-08-01T12:42:40Z

Hi Jon,

On Saturday 01 August 2015 13:22:10 Jonathan Corbet wrote:
> On Fri, 31 Jul 2015 18:06:45 -0300 Danilo Cesar Lemes de Paula wrote:
> > Describing arguments at top of a struct definition works fine
> > for small/medium size structs, but it definitely doesn't work well
> > for struct with a huge list of elements.
> >
> > Keeping the arguments list inside the struct body makes it easier
> > to maintain the documentation.
>
> Interesting approach. I think it could make sense, but I fear pushback
> from a subset of maintainers refusing to accept this mode. I wonder what
> it would take to get a consensus on allowing these in-struct comments?
>
> I'm wondering if we need a kernel summit session on commenting
> conventions, markdown-in-kerneldoc, etc? Maybe I'll stick a proposal out
> there.

The topic of documentation has been raised in the mail thread of the kernel
recruitment proposal for the kernel summit. I believe it's an important one,
and I will be very interested in contributing if it is discussed as a separate
topic.

--
Regards,

Laurent Pinchart