motorhead/qemu
1
0
Fork 0
mirror of https://github.com/Motorhead1991/qemu.git synced 2025-07-31 14:23:53 -06:00
Code Issues Projects Releases Packages Wiki Activity Actions

qapi2texi: Implement boxed argument documentation

Browse source 
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>
This commit is contained in:
Markus Armbruster 2017-03-15 13:57:13 +01:00
parent 2c99f5fdc8
commit c2dd311cb7
3 changed files with 8 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

8
scripts/qapi2texi.py
View file

@ -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