Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > linux.kernel > #1197977

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

Show all headers | View raw

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
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/

Back to linux.kernel | Previous | Next — Next in thread | Find similar | Unroll thread

Thread

Re: [PATCH] scripts/kernel-doc Allow struct arguments documentation  in struct body Jonathan Corbet <corbet@lwn.net> - 2015-08-01 13:30 +0200
  Re: [PATCH] scripts/kernel-doc Allow struct arguments documentation  in struct body Daniel Vetter <daniel@ffwll.ch> - 2015-08-03 10:30 +0200
    Re: [PATCH] scripts/kernel-doc Allow struct arguments documentation  in struct body Jonathan Corbet <corbet@lwn.net> - 2015-08-03 16:40 +0200
      Re: [PATCH] scripts/kernel-doc Allow struct arguments documentation  in struct body Daniel Vetter <daniel@ffwll.ch> - 2015-08-03 17:40 +0200

csiph-web