diff options
| author | Markus Armbruster <armbru@redhat.com> | 2019-10-24 13:02:24 +0200 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2019-10-29 07:35:16 +0100 |
| commit | b621a26040dd626cf9098c277e763f55fcfacf67 (patch) | |
| tree | 67f26deea46e75c69a38865c448d84eab17ae9fe /scripts/qapi | |
| parent | 6d570ca10e3d7c628cdb5d8b8b5ea4fd3b994d9f (diff) | |
qapi: Implement boxed event argument documentation
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 <armbru@redhat.com>
Message-Id: <20191024110237.30963-7-armbru@redhat.com>
Diffstat (limited to 'scripts/qapi')
| -rw-r--r-- | scripts/qapi/doc.py | 10 |
1 files changed, 9 insertions, 1 deletions
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: |