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

Eduardo Habkost posted 9 patches 3 years, 7 months ago
Failed in applying to current master (apply log)
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
[PATCH 0/9] docs: Convert QOM documentation to kernel-doc + Sphinx
Posted by Eduardo Habkost 3 years, 7 months ago
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



Re: [PATCH 0/9] docs: Convert QOM documentation to kernel-doc + Sphinx
Posted by Paolo Bonzini 3 years, 7 months ago
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