[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[PATCH 0/9] docs: Convert QOM documentation to kernel-doc + Sphinx

From: Eduardo Habkost
Subject: [PATCH 0/9] docs: Convert QOM documentation to kernel-doc + Sphinx
Date: Thu, 10 Sep 2020 18:15:17 -0400

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

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


reply via email to

[Prev in Thread] Current Thread [Next in Thread]