aboutsummaryrefslogtreecommitdiff
path: root/scripts/gdb/linux/modules.py
diff options
context:
space:
mode:
authorDanilo Cesar Lemes de Paula <[email protected]>2015-08-04 09:04:08 -0300
committerJonathan Corbet <[email protected]>2015-08-06 13:05:35 -0600
commita4c6ebede2f99fc3aaa5a42228a16747d0aa2504 (patch)
tree14b2121cd22d9e58e10ec07c05d963740142aeb1 /scripts/gdb/linux/modules.py
parent64e32895f9d87aaa0842c07d0b17f4895955db20 (diff)
scripts/kernel-doc Allow struct arguments documentation in struct body
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 - short description * @a: first member * @b: second member * * Longer description */ struct my_struct { int a; int b; /** * @c: This is longer description of C * * You can use paragraphs to describe arguments * using this method. */ int c; }; This patch allows the use of this kind of syntax. Only one argument per comment and user can use how many paragraphs he needs. It should start with /**, which is already being used by kernel-doc. If those comment doesn't follow those rules, it will be ignored. Signed-off-by: Danilo Cesar Lemes de Paula <[email protected]> Cc: Randy Dunlap <[email protected]> Cc: Daniel Vetter <[email protected]> Cc: Laurent Pinchart <[email protected]> Cc: Jonathan Corbet <[email protected]> Cc: Herbert Xu <[email protected]> Cc: Stephan Mueller <[email protected]> Cc: Michal Marek <[email protected]> Cc: [email protected] Cc: [email protected] Cc: intel-gfx <[email protected]> Cc: dri-devel <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
Diffstat (limited to 'scripts/gdb/linux/modules.py')
0 files changed, 0 insertions, 0 deletions