qdev: Move doc comments from qdev.c to qdev-core.h
commitb51238e251cefb496b60d3db992af175fb354a68
authorPeter Maydell <peter.maydell@linaro.org>
Sat, 11 Jul 2020 14:24:23 +0000 (11 15:24 +0100)
committerPeter Maydell <peter.maydell@linaro.org>
Mon, 20 Jul 2020 10:35:17 +0000 (20 11:35 +0100)
treef2d60973344f562cd683125211697d5c3f05456a
parent8edbca515c20bdbb3d2dca3c60dcc5b8ca4fc718
qdev: Move doc comments from qdev.c to qdev-core.h

The doc-comments which document the qdev API are split between the
header file and the C source files, because as a project we haven't
been consistent about where we put them.

Move all the doc-comments in qdev.c to the header files, so that
users of the APIs don't have to look at the implementation files for
this information.

In the process, unify them into our doc-comment format and expand on
them in some cases to clarify expected use cases.

Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Reviewed-by: Richard Henderson <richard.henderson@linaro.org>
Message-id: 20200711142425.16283-2-peter.maydell@linaro.org
hw/core/qdev.c
include/hw/qdev-core.h
include/hw/qdev-properties.h