diff options
author | Markus Armbruster <armbru@redhat.com> | 2017-03-15 13:57:12 +0100 |
---|---|---|
committer | Markus Armbruster <armbru@redhat.com> | 2017-03-16 07:13:03 +0100 |
commit | 2c99f5fdc8a1e3decbb2c3bd99090ecb816a3d95 (patch) | |
tree | 2ee4f8579cf6b713216979ddc10245e79a712453 /scripts/qapi2texi.py | |
parent | 5da19f14ff3393dc84f0f84c50770affd2c10acf (diff) | |
download | qemu-2c99f5fdc8a1e3decbb2c3bd99090ecb816a3d95.zip qemu-2c99f5fdc8a1e3decbb2c3bd99090ecb816a3d95.tar.gz qemu-2c99f5fdc8a1e3decbb2c3bd99090ecb816a3d95.tar.bz2 |
qapi2texi: Don't hide undocumented members and arguments
Show undocumented object, alternate type members and command, event
arguments exactly like undocumented enumeration type values.
Example change (qemu-qmp-ref.txt):
-- Command: query-rocker
Return rocker switch information.
+ Arguments:
+ 'name'
+ Not documented
+
Returns: 'Rocker' information
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Message-Id: <1489582656-31133-24-git-send-email-armbru@redhat.com>
Diffstat (limited to 'scripts/qapi2texi.py')
-rwxr-xr-x | scripts/qapi2texi.py | 12 |
1 files changed, 4 insertions, 8 deletions
diff --git a/scripts/qapi2texi.py b/scripts/qapi2texi.py index 1f01817..df87441 100755 --- a/scripts/qapi2texi.py +++ b/scripts/qapi2texi.py @@ -139,12 +139,10 @@ def texi_member(member): member.name, ' (optional)' if member.optional else '') -def texi_members(doc, what, member_func, show_undocumented): +def texi_members(doc, what, member_func): """Format the table of members""" items = '' for section in doc.args.itervalues(): - if not section.content and not show_undocumented: - continue # Undocumented TODO require doc and drop if section.content: desc = str(section) else: @@ -172,10 +170,9 @@ def texi_sections(doc): return body -def texi_entity(doc, what, member_func=texi_member, - show_undocumented=False): +def texi_entity(doc, what, member_func=texi_member): return (texi_body(doc) - + texi_members(doc, what, member_func, show_undocumented) + + texi_members(doc, what, member_func) + texi_sections(doc)) @@ -194,8 +191,7 @@ class QAPISchemaGenDocVisitor(qapi.QAPISchemaVisitor): self.out += TYPE_FMT(type='Enum', name=doc.symbol, body=texi_entity(doc, 'Values', - member_func=texi_enum_value, - show_undocumented=True)) + member_func=texi_enum_value)) def visit_object_type(self, name, info, base, members, variants): doc = self.cur_doc |