diff options
| author | Alex Bennée <alex.bennee@linaro.org> | 2023-06-30 19:04:11 +0100 |
|---|---|---|
| committer | Alex Bennée <alex.bennee@linaro.org> | 2023-07-03 12:52:22 +0100 |
| commit | da966a8a7ccb3811546bf141e17e928ea291256e (patch) | |
| tree | 0cee3a17d5d7e8e1aa4692646cc3361904a2d128 /docs | |
| parent | 307c0a4ac9c7acb7937ef663b2369f081ba94cd0 (diff) | |
| download | qemu-da966a8a7ccb3811546bf141e17e928ea291256e.zip qemu-da966a8a7ccb3811546bf141e17e928ea291256e.tar.gz qemu-da966a8a7ccb3811546bf141e17e928ea291256e.tar.bz2 | |
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>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/devel/index-api.rst | 2 | ||||
| -rw-r--r-- | docs/devel/qdev-api.rst | 7 | ||||
| -rw-r--r-- | docs/devel/qom-api.rst | 9 | ||||
| -rw-r--r-- | docs/devel/qom.rst | 3 |
4 files changed, 20 insertions, 1 deletions
diff --git a/docs/devel/index-api.rst b/docs/devel/index-api.rst index 7108821..539ad29 100644 --- a/docs/devel/index-api.rst +++ b/docs/devel/index-api.rst @@ -11,5 +11,7 @@ generated from in-code annotations to function prototypes. loads-stores memory modules + qom-api + qdev-api ui zoned-storage diff --git a/docs/devel/qdev-api.rst b/docs/devel/qdev-api.rst new file mode 100644 index 0000000..3f35eea --- /dev/null +++ b/docs/devel/qdev-api.rst @@ -0,0 +1,7 @@ +.. _qdev-api: + +================================ +QEMU Device (qdev) API Reference +================================ + +.. kernel-doc:: include/hw/qdev-core.h diff --git a/docs/devel/qom-api.rst b/docs/devel/qom-api.rst new file mode 100644 index 0000000..ed1f17e --- /dev/null +++ b/docs/devel/qom-api.rst @@ -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 diff --git a/docs/devel/qom.rst b/docs/devel/qom.rst index 2828843..c342ce1 100644 --- a/docs/devel/qom.rst +++ b/docs/devel/qom.rst @@ -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. |