summaryrefslogtreecommitdiffstats
path: root/include/qom
diff options
context:
space:
mode:
authorEduardo Habkost2020-09-11 00:15:22 +0200
committerPaolo Bonzini2020-09-30 19:11:36 +0200
commit881444687571d8b23f308f76bef326ab860685b4 (patch)
treee35d0d70fb45bf423a82cc1a99ef43529cc26558 /include/qom
parentqom: Add kernel-doc markup to introduction doc comment (diff)
downloadqemu-881444687571d8b23f308f76bef326ab860685b4.tar.gz
qemu-881444687571d8b23f308f76bef326ab860685b4.tar.xz
qemu-881444687571d8b23f308f76bef326ab860685b4.zip
qom: Reformat section titles using Sphinx syntax
Signed-off-by: Eduardo Habkost <ehabkost@redhat.com> Message-Id: <20200910221526.10041-6-ehabkost@redhat.com> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
Diffstat (limited to 'include/qom')
-rw-r--r--include/qom/object.h12
1 files changed, 8 insertions, 4 deletions
diff --git a/include/qom/object.h b/include/qom/object.h
index 7747a1e3d8..7b5800959a 100644
--- a/include/qom/object.h
+++ b/include/qom/object.h
@@ -120,7 +120,8 @@ typedef struct InterfaceInfo InterfaceInfo;
* </programlisting>
* </example>
*
- * # Class Initialization #
+ * Class Initialization
+ * ====================
*
* Before an object is initialized, the class for the object must be
* initialized. There is only one class object for all instance objects
@@ -193,7 +194,8 @@ typedef struct InterfaceInfo InterfaceInfo;
* </programlisting>
* </example>
*
- * # Interfaces #
+ * Interfaces
+ * ==========
*
* Interfaces allow a limited form of multiple inheritance. Instances are
* similar to normal types except for the fact that are only defined by
@@ -206,7 +208,8 @@ typedef struct InterfaceInfo InterfaceInfo;
* an argument to a method on its corresponding SomethingIfClass, or to
* dynamically cast it to an object that implements the interface.
*
- * # Methods #
+ * Methods
+ * =======
*
* A <emphasis>method</emphasis> is a function within the namespace scope of
* a class. It usually operates on the object instance by passing it as a
@@ -304,7 +307,8 @@ typedef struct InterfaceInfo InterfaceInfo;
* The first example of such a QOM method was #CPUClass.reset,
* another example is #DeviceClass.realize.
*
- * # Standard type declaration and definition macros #
+ * Standard type declaration and definition macros
+ * ===============================================
*
* A lot of the code outlined above follows a standard pattern and naming
* convention. To reduce the amount of boilerplate code that needs to be