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

2015-08-04 Thread Daniel Vetter
On Fri, Jul 31, 2015 at 06:06:45PM -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

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

2015-08-03 Thread Daniel Vetter
On Mon, Aug 03, 2015 at 08:37:41AM -0600, Jonathan Corbet wrote: > On Mon, 3 Aug 2015 10:23:19 +0200 > Daniel Vetter wrote: > > > > 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. > > >

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

2015-08-03 Thread Danilo Cesar Lemes de Paula
On 08/03/2015 12:59 PM, Randy Dunlap wrote: > On 07/31/15 14:06, 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

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

2015-08-03 Thread Daniel Vetter
On Sat, Aug 01, 2015 at 01:22:10PM +0200, 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

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

2015-08-03 Thread Randy Dunlap
On 07/31/15 14:06, 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

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

2015-08-03 Thread Jonathan Corbet
On Mon, 3 Aug 2015 10:23:19 +0200 Daniel Vetter wrote: > > 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. > > Might be useful, but I'm not sure how many people really would actively > work

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

2015-08-01 Thread Laurent Pinchart
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

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

2015-08-01 Thread Jonathan Corbet
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

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

2015-07-31 Thread Danilo Cesar Lemes de Paula
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. ie: /** * struct my_struct -