[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 5/9] qom: Reformat section titles using Sphinx syntax
From: |
Eduardo Habkost |
Subject: |
[PATCH 5/9] qom: Reformat section titles using Sphinx syntax |
Date: |
Thu, 10 Sep 2020 18:15:22 -0400 |
Signed-off-by: Eduardo Habkost <ehabkost@redhat.com>
---
include/qom/object.h | 12 ++++++++----
1 file changed, 8 insertions(+), 4 deletions(-)
diff --git a/include/qom/object.h b/include/qom/object.h
index d2eecdf872..da9ecb310f 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
--
2.26.2
- [PATCH 0/9] docs: Convert QOM documentation to kernel-doc + Sphinx, Eduardo Habkost, 2020/09/10
- [PATCH 1/9] qom: Document all function parameters in doc comments, Eduardo Habkost, 2020/09/10
- [PATCH 2/9] qom: Use kernel-doc private/public tags in structs, Eduardo Habkost, 2020/09/10
- [PATCH 3/9] qom: Use ``code`` Sphinx syntax where appropriate, Eduardo Habkost, 2020/09/10
- [PATCH 4/9] qom: Add kernel-doc markup to introduction doc comment, Eduardo Habkost, 2020/09/10
- [PATCH 5/9] qom: Reformat section titles using Sphinx syntax,
Eduardo Habkost <=
- [PATCH 7/9] qom: Add code block markup to all code blocks, Eduardo Habkost, 2020/09/10
- [PATCH 6/9] qom: Indent existing code examples, Eduardo Habkost, 2020/09/10
- [PATCH 8/9] docs: Create docs/devel/qom.rst, Eduardo Habkost, 2020/09/10
- [PATCH 9/9] docs: Move object.h overview doc comment to qom.rst, Eduardo Habkost, 2020/09/10
- Re: [PATCH 0/9] docs: Convert QOM documentation to kernel-doc + Sphinx, Paolo Bonzini, 2020/09/22