docs: Convert QOM documentation to kernel-doc + Sphinx
Status from this message: Queued, thanks.
Get series with b4
b4 am [email protected]Versions newest first
Patches in v1 Applied
| # | Subject and files | Size | Replies | Applied |
|---|---|---|---|---|
| 1/9 | qom: Document all function parameters in doc commentsinclude/ | +45 | 0 replies | |
| 2/9 | qom: Use kernel-doc private/public tags in structsinclude/ | +3 | 0 replies | |
| 3/9 | qom: Use ``code`` Sphinx syntax where appropriateinclude/ | +3 | 0 replies | |
| 4/9 | qom: Add kernel-doc markup to introduction doc commentinclude/ | +1 | 0 replies | |
| 5/9 | qom: Reformat section titles using Sphinx syntaxinclude/ | +8 | 0 replies | |
| 6/9 | qom: Indent existing code examplesinclude/ | +188 | 0 replies | |
| 7/9 | qom: Add code block markup to all code blocksinclude/ | +56 | 0 replies | |
| 8/9 | docs: Create docs/devel/qom.rstdocs/ docs/ | +6 | 0 replies | |
| 9/9 | docs: Move object.h overview doc comment to qom.rstdocs/ include/ | +373 | 1 reply |
Reviews trailers per patch
No Reviewed-by, Acked-by or Tested-by trailers for v1 yet.
Cover letter [PATCH 0/9] docs: Convert QOM documentation to kernel-doc + Sphinx
This converts the existing gtk-doc markup in object.h (that probably was never rendered into an actual document) to kernel-doc + Sphinx syntax, and reference them at docs/devel/qom.rst.
Eduardo Habkost (9):
qom: Document all function parameters in doc comments
qom: Use kernel-doc private/public tags in structs
qom: Use ``code`` Sphinx syntax where appropriate
qom: Add kernel-doc markup to introduction doc comment
qom: Reformat section titles using Sphinx syntax
qom: Indent existing code examples
qom: Add code block markup to all code blocks
docs: Create docs/devel/qom.rst
docs: Move object.h overview doc comment to qom.rst
docs/devel/index.rst | 1 + docs/devel/qom.rst | 378 ++++++++++++++++++++++++++++++ include/qom/object.h | 547 ++++++++----------------------------------- 3 files changed, 475 insertions(+), 451 deletions(-) create mode 100644 docs/devel/qom.rst
Signature · 1 line
2.26.2