[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 13/19] qapi: Eliminate .check_doc() overrides
From: |
Markus Armbruster |
Subject: |
[PATCH 13/19] qapi: Eliminate .check_doc() overrides |
Date: |
Thu, 24 Oct 2019 13:02:31 +0200 |
All sub-classes of QAPISchemaEntity now override .check_doc() the same
way, except for QAPISchemaType and and QAPISchemaArrayType.
Put the overrides' code in QAPISchemaEntity.check_doc(), and drop the
overrides. QAPISchemaType doesn't care because it's abstract.
QAPISchemaArrayType doesn't care because its .doc is always None.
Signed-off-by: Markus Armbruster <address@hidden>
---
scripts/qapi/schema.py | 23 ++---------------------
1 file changed, 2 insertions(+), 21 deletions(-)
diff --git a/scripts/qapi/schema.py b/scripts/qapi/schema.py
index 27da4e0f7d..ee510f129b 100644
--- a/scripts/qapi/schema.py
+++ b/scripts/qapi/schema.py
@@ -55,7 +55,8 @@ class QAPISchemaEntity(object):
pass
def check_doc(self):
- pass
+ if self.doc:
+ self.doc.check()
@property
def ifcond(self):
@@ -230,10 +231,6 @@ class QAPISchemaEnumType(QAPISchemaType):
for m in self.members:
doc.connect_member(m)
- def check_doc(self):
- if self.doc:
- self.doc.check()
-
def is_implicit(self):
# See QAPISchema._make_implicit_enum_type() and ._def_predefineds()
return self.name.endswith('Kind') or self.name == 'QType'
@@ -389,10 +386,6 @@ class QAPISchemaObjectType(QAPISchemaType):
for m in self.local_members:
doc.connect_member(m)
- def check_doc(self):
- if self.doc:
- self.doc.check()
-
@property
def ifcond(self):
assert self._checked
@@ -667,10 +660,6 @@ class QAPISchemaAlternateType(QAPISchemaType):
for v in self.variants.variants:
doc.connect_member(v)
- def check_doc(self):
- if self.doc:
- self.doc.check()
-
def c_type(self):
return c_name(self.name) + pointer_suffix
@@ -745,10 +734,6 @@ class QAPISchemaCommand(QAPISchemaEntity):
if self.arg_type and self.arg_type.is_implicit():
self.arg_type.connect_doc(doc)
- def check_doc(self):
- if self.doc:
- self.doc.check()
-
def visit(self, visitor):
QAPISchemaEntity.visit(self, visitor)
visitor.visit_command(self.name, self.info, self.ifcond,
@@ -791,10 +776,6 @@ class QAPISchemaEvent(QAPISchemaEntity):
if self.arg_type and self.arg_type.is_implicit():
self.arg_type.connect_doc(doc)
- def check_doc(self):
- if self.doc:
- self.doc.check()
-
def visit(self, visitor):
QAPISchemaEntity.visit(self, visitor)
visitor.visit_event(self.name, self.info, self.ifcond,
--
2.21.0
- [PATCH 00/19] qapi: Doc generation fixes, Markus Armbruster, 2019/10/24
- [PATCH 01/19] tests/qapi-schema: Demonstrate feature and enum doc comment bugs, Markus Armbruster, 2019/10/24
- [PATCH 13/19] qapi: Eliminate .check_doc() overrides,
Markus Armbruster <=
- [PATCH 16/19] qapi: Fold normalize_enum() into check_enum(), Markus Armbruster, 2019/10/24
- [PATCH 12/19] qapi: Simplify ._make_implicit_object_type(), Markus Armbruster, 2019/10/24
- [PATCH 05/19] qemu-doc: Belatedly document QMP command deprecation, Markus Armbruster, 2019/10/24
- [PATCH 10/19] qapi: Clean up doc comment checking for implicit union base, Markus Armbruster, 2019/10/24
- [PATCH 08/19] qapi: Split .connect_doc(), .check_doc() off .check(), Markus Armbruster, 2019/10/24
- [PATCH 18/19] qapi: Polish reporting of bogus member documentation, Markus Armbruster, 2019/10/24
- [PATCH 04/19] tests/qapi-schema: Fix feature documentation testing, Markus Armbruster, 2019/10/24
- [PATCH 03/19] tests/qapi-schema: Cover alternate documentation comments, Markus Armbruster, 2019/10/24
- [PATCH 09/19] qapi: Fix enum doc comment checking, Markus Armbruster, 2019/10/24
- [PATCH 07/19] qapi: De-duplicate entity documentation generation code, Markus Armbruster, 2019/10/24