diff options
| author | Markus Armbruster <armbru@redhat.com> | 2017-03-15 13:57:13 +0100 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2017-03-16 07:13:03 +0100 |
| commit | c2dd311cb72b0ef59287aad3c0c7ee968c7289e2 (patch) | |
| tree | 75e8b268d60230875a38bd98bcb20763a5b02201 /scripts | |
| parent | 2c99f5fdc8a1e3decbb2c3bd99090ecb816a3d95 (diff) | |
qapi2texi: Implement boxed argument documentation
This replaces manual references like "For the arguments, see the
documentation of ..." by a generated reference "Arguments: the members
of ...".
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Message-Id: <1489582656-31133-25-git-send-email-armbru@redhat.com>
Diffstat (limited to 'scripts')
| -rwxr-xr-x | scripts/qapi2texi.py | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/scripts/qapi2texi.py b/scripts/qapi2texi.py index df874415e3..3dd0146ba0 100755 --- a/scripts/qapi2texi.py +++ b/scripts/qapi2texi.py @@ -220,9 +220,15 @@ class QAPISchemaGenDocVisitor(qapi.QAPISchemaVisitor): doc = self.cur_doc if self.out: self.out += '\n' + if boxed: + body = texi_body(doc) + body += '\n@b{Arguments:} the members of @code{%s}' % arg_type.name + body += texi_sections(doc) + else: + body = texi_entity(doc, 'Arguments') self.out += MSG_FMT(type='Command', name=doc.symbol, - body=texi_entity(doc, 'Arguments')) + body=body) def visit_event(self, name, info, arg_type, boxed): doc = self.cur_doc |