[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 4/9] qom: Add kernel-doc markup to introduction doc comment
From: |
Eduardo Habkost |
Subject: |
[PATCH 4/9] qom: Add kernel-doc markup to introduction doc comment |
Date: |
Thu, 10 Sep 2020 18:15:21 -0400 |
Add DOC: section keyword to introduction doc comment, so it will
be rendered by kernel-doc.
Signed-off-by: Eduardo Habkost <ehabkost@redhat.com>
---
include/qom/object.h | 4 +---
1 file changed, 1 insertion(+), 3 deletions(-)
diff --git a/include/qom/object.h b/include/qom/object.h
index 4fb528d841..d2eecdf872 100644
--- a/include/qom/object.h
+++ b/include/qom/object.h
@@ -29,9 +29,7 @@ typedef struct InterfaceInfo InterfaceInfo;
#define TYPE_OBJECT "object"
/**
- * SECTION:object.h
- * @title:Base Object Type System
- * @short_description: interfaces for creating new types and objects
+ * DOC:
*
* The QEMU Object Model provides a framework for registering user creatable
* types and instantiating objects from those types. QOM provides the
following
--
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 <=
- [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