[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 06/19] qapi: Implement boxed event argument documentation
From: |
Markus Armbruster |
Subject: |
[PATCH 06/19] qapi: Implement boxed event argument documentation |
Date: |
Thu, 24 Oct 2019 13:02:24 +0200 |
Generate a reference "Arguments: the members of ...", just like we do
for commands since commit c2dd311cb7 "qapi2texi: Implement boxed
argument documentation".
No change to generated QMP documentation; we don't yet use boxed
events outside tests/.
Signed-off-by: Markus Armbruster <address@hidden>
---
tests/qapi-schema/doc-good.texi | 4 +++-
scripts/qapi/doc.py | 10 +++++++++-
tests/qapi-schema/doc-good.json | 1 -
tests/qapi-schema/doc-good.out | 2 +-
4 files changed, 13 insertions(+), 4 deletions(-)
diff --git a/tests/qapi-schema/doc-good.texi b/tests/qapi-schema/doc-good.texi
index 98aa78e1fb..d4b15dabf0 100644
--- a/tests/qapi-schema/doc-good.texi
+++ b/tests/qapi-schema/doc-good.texi
@@ -279,7 +279,9 @@ another feature
@deftypefn Event {} EVT-BOXED
-BUG: generated doc misses arguments
+
+
+@b{Arguments:} the members of @code{Object}
@end deftypefn
diff --git a/scripts/qapi/doc.py b/scripts/qapi/doc.py
index 6d5726cf6e..f2462c9877 100644
--- a/scripts/qapi/doc.py
+++ b/scripts/qapi/doc.py
@@ -266,9 +266,17 @@ class QAPISchemaGenDocVisitor(QAPISchemaVisitor):
def visit_event(self, name, info, ifcond, arg_type, boxed):
doc = self.cur_doc
+ if boxed:
+ body = texi_body(doc)
+ body += ('\n@b{Arguments:} the members of @code{%s}\n'
+ % arg_type.name)
+ body += texi_features(doc)
+ body += texi_sections(doc, ifcond)
+ else:
+ body = texi_entity(doc, 'Arguments', ifcond)
self._gen.add(MSG_FMT(type='Event',
name=doc.symbol,
- body=texi_entity(doc, 'Arguments', ifcond)))
+ body=body))
def symbol(self, doc, entity):
if self._gen._body:
diff --git a/tests/qapi-schema/doc-good.json b/tests/qapi-schema/doc-good.json
index df50a877e3..d992e713d9 100644
--- a/tests/qapi-schema/doc-good.json
+++ b/tests/qapi-schema/doc-good.json
@@ -160,7 +160,6 @@
##
# @EVT-BOXED:
-# BUG: generated doc misses arguments
##
{ 'event': 'EVT-BOXED', 'boxed': true,
'data': 'Object' }
diff --git a/tests/qapi-schema/doc-good.out b/tests/qapi-schema/doc-good.out
index 8cc29fce50..4c9406a464 100644
--- a/tests/qapi-schema/doc-good.out
+++ b/tests/qapi-schema/doc-good.out
@@ -196,4 +196,4 @@ another feature
<- out
doc symbol=EVT-BOXED
body=
-BUG: generated doc misses arguments
+
--
2.21.0
- [PATCH 04/19] tests/qapi-schema: Fix feature documentation testing, (continued)
- [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
- [PATCH 11/19] qapi: Fix doc comment checking for commands and events, Markus Armbruster, 2019/10/24
- [PATCH 15/19] qapi: Fold normalize_features() into check_features(), Markus Armbruster, 2019/10/24
- [PATCH 02/19] tests/qapi-schema: Demonstrate command and event doc comment bugs, Markus Armbruster, 2019/10/24
- [PATCH 19/19] qapi: Check feature documentation against the schema, Markus Armbruster, 2019/10/24
- [PATCH 14/19] qapi: Fold normalize_if() into check_if(), Markus Armbruster, 2019/10/24
- [PATCH 17/19] qapi: Lift features into QAPISchemaEntity, Markus Armbruster, 2019/10/24
- [PATCH 06/19] qapi: Implement boxed event argument documentation,
Markus Armbruster <=