diff mbox series

fixup! docs: Move object.h overview doc comment to qom.rst

Message ID 20200911002333.GP1618070@habkost.net
State New
Headers show
Series docs: Convert QOM documentation to kernel-doc + Sphinx | expand

Commit Message

Eduardo Habkost Sept. 11, 2020, 12:23 a.m. UTC
On Thu, Sep 10, 2020 at 06:15:26PM -0400, Eduardo Habkost wrote:
> Move the whole contents of the overview doc comment from object.h
> to qom.rst.
> 
> This makes the documentation source easier to read and edit, and
> also solves the backslash escaping issue at the typecasting macro
> examples.
> 
> Signed-off-by: Eduardo Habkost <ehabkost@redhat.com>

Fixup for a bug I introduced accidentally before sending the
series.

Signed-off-by: Eduardo Habkost <ehabkost@redhat.com>
---
diff mbox series

Patch

diff --git a/docs/devel/qom.rst b/docs/devel/qom.rst
index 2070a2ced4..1a2e5dc661 100644
--- a/docs/devel/qom.rst
+++ b/docs/devel/qom.rst
@@ -80,7 +80,7 @@  specific type:
 .. code-block::
    :caption: Typecasting macros
 
-#define MY_DEVICE_GET_CLASS(obj) \
+    #define MY_DEVICE_GET_CLASS(obj) \
       OBJECT_GET_CLASS(MyDeviceClass, obj, TYPE_MY_DEVICE)
    #define MY_DEVICE_CLASS(klass) \
       OBJECT_CLASS_CHECK(MyDeviceClass, klass, TYPE_MY_DEVICE)