[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 3/9] qom: Use ``code`` Sphinx syntax where appropriate
From: |
Eduardo Habkost |
Subject: |
[PATCH 3/9] qom: Use ``code`` Sphinx syntax where appropriate |
Date: |
Thu, 10 Sep 2020 18:15:20 -0400 |
Replace gtkdoc markup with Sphinx ``code`` syntax.
Signed-off-by: Eduardo Habkost <ehabkost@redhat.com>
---
include/qom/object.h | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/include/qom/object.h b/include/qom/object.h
index f85718380d..4fb528d841 100644
--- a/include/qom/object.h
+++ b/include/qom/object.h
@@ -203,8 +203,8 @@ typedef struct InterfaceInfo InterfaceInfo;
* an interface instance should always be of incomplete type in order to be
* sure it cannot be dereferenced. That is, you should define the
* 'typedef struct SomethingIf SomethingIf' so that you can pass around
- * 'SomethingIf *si' arguments, but not define a 'struct SomethingIf { ... }'.
- * The only things you can validly do with a 'SomethingIf *' are to pass it as
+ * ``SomethingIf *si`` arguments, but not define a ``struct SomethingIf { ...
}``.
+ * The only things you can validly do with a ``SomethingIf *`` are to pass it
as
* an argument to a method on its corresponding SomethingIfClass, or to
* dynamically cast it to an object that implements the interface.
*
@@ -301,7 +301,7 @@ typedef struct InterfaceInfo InterfaceInfo;
*
* Alternatively, object_class_by_name() can be used to obtain the class and
* its non-overridden methods for a specific type. This would correspond to
- * |[ MyClass::method(...) ]| in C++.
+ * ``MyClass::method(...)`` in C++.
*
* The first example of such a QOM method was #CPUClass.reset,
* another example is #DeviceClass.realize.
--
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 <=
- [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, 2020/09/10
- [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