From: Eduardo Habkost <ehabkost@redhat.com>
To: qemu-devel@nongnu.org
Cc: "Paolo Bonzini" <pbonzini@redhat.com>,
"Daniel P. Berrangé" <berrange@redhat.com>,
"Eduardo Habkost" <ehabkost@redhat.com>,
"Peter Maydell" <peter.maydell@linaro.org>
Subject: [PATCH 0/9] docs: Convert QOM documentation to kernel-doc + Sphinx
Date: Thu, 10 Sep 2020 18:15:17 -0400 [thread overview]
Message-ID: <20200910221526.10041-1-ehabkost@redhat.com> (raw)
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
--
2.26.2
next reply other threads:[~2020-09-10 22:17 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-09-10 22:15 Eduardo Habkost [this message]
2020-09-10 22:15 ` [PATCH 1/9] qom: Document all function parameters in doc comments Eduardo Habkost
2020-09-10 22:15 ` [PATCH 2/9] qom: Use kernel-doc private/public tags in structs Eduardo Habkost
2020-09-10 22:15 ` [PATCH 3/9] qom: Use ``code`` Sphinx syntax where appropriate Eduardo Habkost
2020-09-10 22:15 ` [PATCH 4/9] qom: Add kernel-doc markup to introduction doc comment Eduardo Habkost
2020-09-10 22:15 ` [PATCH 5/9] qom: Reformat section titles using Sphinx syntax Eduardo Habkost
2020-09-10 22:15 ` [PATCH 6/9] qom: Indent existing code examples Eduardo Habkost
2020-09-10 22:15 ` [PATCH 7/9] qom: Add code block markup to all code blocks Eduardo Habkost
2020-09-10 22:15 ` [PATCH 8/9] docs: Create docs/devel/qom.rst Eduardo Habkost
2020-09-10 22:15 ` [PATCH 9/9] docs: Move object.h overview doc comment to qom.rst Eduardo Habkost
2020-09-11 0:23 ` fixup! " Eduardo Habkost
2020-09-22 9:38 ` [PATCH 0/9] docs: Convert QOM documentation to kernel-doc + Sphinx Paolo Bonzini
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200910221526.10041-1-ehabkost@redhat.com \
--to=ehabkost@redhat.com \
--cc=berrange@redhat.com \
--cc=pbonzini@redhat.com \
--cc=peter.maydell@linaro.org \
--cc=qemu-devel@nongnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).