docs/devel: split qom-api reference into new file

Lets try and keep the overview of the sub-system digestible by
splitting the core API stuff into a separate file. As QOM and QDEV
work together we should also try and enumerate the qdev_ functions.

Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org>
Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
Message-Id: <20230630180423.558337-27-alex.bennee@linaro.org>
This commit is contained in:
Alex Bennée 2023-06-30 19:04:11 +01:00
parent 307c0a4ac9
commit da966a8a7c
4 changed files with 20 additions and 1 deletions

View File

@ -11,5 +11,7 @@ generated from in-code annotations to function prototypes.
loads-stores
memory
modules
qom-api
qdev-api
ui
zoned-storage

7
docs/devel/qdev-api.rst Normal file
View File

@ -0,0 +1,7 @@
.. _qdev-api:
================================
QEMU Device (qdev) API Reference
================================
.. kernel-doc:: include/hw/qdev-core.h

9
docs/devel/qom-api.rst Normal file
View File

@ -0,0 +1,9 @@
.. _qom-api:
=====================================
QEMU Object Model (QOM) API Reference
=====================================
This is the complete API documentation for :ref:`qom`.
.. kernel-doc:: include/qom/object.h

View File

@ -387,4 +387,5 @@ OBJECT_DEFINE_ABSTRACT_TYPE() macro can be used instead:
API Reference
-------------
.. kernel-doc:: include/qom/object.h
See the :ref:`QOM API<qom-api>` and :ref:`QDEV API<qdev-api>`
documents for the complete API description.