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

Jonathan Corbet
2015-08-01T11:22:15Z

On Fri, 31 Jul 2015 18:06:45 -0300
Danilo Cesar Lemes de Paula <danilo.cesar@collabora.co.uk> 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.

Thanks,

jon