diff mbox series

[4/9] qom: Add kernel-doc markup to introduction doc comment

Message ID 20200910221526.10041-5-ehabkost@redhat.com (mailing list archive)
State New, archived
Headers show
Series docs: Convert QOM documentation to kernel-doc + Sphinx | expand

Commit Message

Eduardo Habkost Sept. 10, 2020, 10:15 p.m. UTC 
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 mbox series

Patch

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