Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]
Groups > linux.kernel > #1740087
| From | Mauro Carvalho Chehab <mchehab@s-opensource.com> |
|---|---|
| Newsgroups | linux.kernel |
| Subject | [PATCH 00/10] kernel-doc: add supported to document nested structs/unions |
| Date | 2017-09-26 20:10 +0200 |
| Message-ID | <uu2sV-8cl-3@gated-at.bofh.it> (permalink) |
| Organization | linux.* mail to news gateway |
Right now, it is not possible to document nested struct and nested unions. kernel-doc simply ignore them. Add support to document them. This series starts with a patch getting rid of the now unused output formats for kernel-doc: since we got rid of all DocBook stuff, we should not need them anymore. The reason for dropping it (despite cleaning up), is that it doesn't make sense to invest time on adding new features for formats that aren't used anymore. The next 8 patches on this series improve kernel-doc documentation and finally get rid of its old documentation (kernel-doc-nano-HOWTO.txt). Patch 9/10 is the most interesting one in this series: it adds support for nested structures and unions. Patch 10/10 is just an example from a random header with kernel-doc markups. There's no special reason for selecting this file, and the comments there are likely wrong. So, please use it only as a way to test the new parser logic from patch 9/10. Mauro Carvalho Chehab (10): scripts: kernel-doc: get rid of unused output formats docs: kernel-doc.rst: better describe kernel-doc arguments docs: kernel-doc.rst: improve private members description docs: kernel-doc.rst: improve function documentation section docs: kernel-doc.rst: improve structs chapter docs: kernel-doc: improve typedef documentation docs: kernel-doc.rst: add documentation about man pages docs: get rid of kernel-doc-nano-HOWTO.txt scripts: kernel-doc: parse next structs/unions [RFC] w1_netlink.h: add support for nested structs --- Before this series, I send a few PoC patches. They were all replaced by patch 9/10. Documentation/00-INDEX | 2 - Documentation/doc-guide/kernel-doc.rst | 387 ++++++--- Documentation/kernel-doc-nano-HOWTO.txt | 322 -------- drivers/w1/w1_netlink.h | 4 + scripts/kernel-doc | 1304 ++----------------------------- 5 files changed, 346 insertions(+), 1673 deletions(-) delete mode 100644 Documentation/kernel-doc-nano-HOWTO.txt -- 2.13.5
Back to linux.kernel | Previous | Next — Next in thread | Find similar | Unroll thread
[PATCH 00/10] kernel-doc: add supported to document nested structs/unions Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-09-26 20:10 +0200
[PATCH 02/10] docs: kernel-doc.rst: better describe kernel-doc arguments Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-09-26 20:10 +0200
Re: [PATCH 02/10] docs: kernel-doc.rst: better describe kernel-doc arguments Randy Dunlap <rdunlap@infradead.org> - 2017-09-27 04:10 +0200
Re: [PATCH 01/10] scripts: kernel-doc: get rid of unused output formats Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-09-27 22:50 +0200
csiph-web