Skip to content

docs: Convert QOM documentation to kernel-doc + Sphinx

Eduardo Habkost qemu-devel 1 version Applied

Status from this message: Queued, thanks.

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest9 patches 2 repliesApplied

Patches in v1 Applied

#Subject and filesSizeRepliesApplied
1/9qom: Document all function parameters in doc commentsinclude/qom/object.h+45 -20 replies
2/9qom: Use kernel-doc private/public tags in structsinclude/qom/object.h+3 -30 replies
3/9qom: Use ``code`` Sphinx syntax where appropriateinclude/qom/object.h+3 -30 replies
4/9qom: Add kernel-doc markup to introduction doc commentinclude/qom/object.h+1 -30 replies
5/9qom: Reformat section titles using Sphinx syntaxinclude/qom/object.h+8 -40 replies
6/9qom: Indent existing code examplesinclude/qom/object.h+188 -1880 replies
7/9qom: Add code block markup to all code blocksinclude/qom/object.h+56 -790 replies
8/9docs: Create docs/devel/qom.rstdocs/devel/index.rst docs/devel/qom.rst+6 -00 replies
9/9docs: Move object.h overview doc comment to qom.rstdocs/devel/qom.rst include/qom/object.h+373 -3771 reply

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v1 yet.

Read the v1 thread

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