[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH 0/9] docs: Convert QOM documentation to kernel-doc + Sphinx
From: |
Paolo Bonzini |
Subject: |
Re: [PATCH 0/9] docs: Convert QOM documentation to kernel-doc + Sphinx |
Date: |
Tue, 22 Sep 2020 11:38:37 +0200 |
User-agent: |
Mozilla/5.0 (X11; Linux x86_64; rv:68.0) Gecko/20100101 Thunderbird/68.11.0 |
On 11/09/20 00:15, Eduardo Habkost wrote:
> 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
>
Queued, thanks.
Paolo
- [PATCH 1/9] qom: Document all function parameters in doc comments, (continued)
- [PATCH 1/9] qom: Document all function parameters in doc comments, Eduardo Habkost, 2020/09/10
- [PATCH 2/9] qom: Use kernel-doc private/public tags in structs, Eduardo Habkost, 2020/09/10
- [PATCH 3/9] qom: Use ``code`` Sphinx syntax where appropriate, Eduardo Habkost, 2020/09/10
- [PATCH 4/9] qom: Add kernel-doc markup to introduction doc comment, Eduardo Habkost, 2020/09/10
- [PATCH 5/9] qom: Reformat section titles using Sphinx syntax, Eduardo Habkost, 2020/09/10
- [PATCH 7/9] qom: Add code block markup to all code blocks, Eduardo Habkost, 2020/09/10
- [PATCH 6/9] qom: Indent existing code examples, Eduardo Habkost, 2020/09/10
- [PATCH 8/9] docs: Create docs/devel/qom.rst, Eduardo Habkost, 2020/09/10
- [PATCH 9/9] docs: Move object.h overview doc comment to qom.rst, Eduardo Habkost, 2020/09/10
- Re: [PATCH 0/9] docs: Convert QOM documentation to kernel-doc + Sphinx,
Paolo Bonzini <=