[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PULL for 2.9 25/49] qapi2texi: Don't hide undocumented mem
From: |
Markus Armbruster |
Subject: |
[Qemu-devel] [PULL for 2.9 25/49] qapi2texi: Don't hide undocumented members and arguments |
Date: |
Thu, 16 Mar 2017 07:27:41 +0100 |
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 <address@hidden>
Reviewed-by: Eric Blake <address@hidden>
Message-Id: <address@hidden>
---
scripts/qapi2texi.py | 12 ++++--------
1 file 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
--
2.7.4
- [Qemu-devel] [PULL for 2.9 26/49] qapi2texi: Implement boxed argument documentation, (continued)
- [Qemu-devel] [PULL for 2.9 26/49] qapi2texi: Implement boxed argument documentation, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 40/49] qapi: Eliminate check_docs() and drop QAPIDoc.expr, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 39/49] qapi: Fix detection of bogus member documentation, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 32/49] tests/qapi-schema: Improve doc / expression mismatch coverage, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 21/49] qapi: Prefer single-quoted strings more consistently, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 29/49] qapi2texi: Generate documentation for variant members, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 18/49] qapi2texi: Convert to QAPISchemaVisitor, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 48/49] qapi: Make pylint a bit happier, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 15/49] qapi: Fix QAPISchemaEnumType.is_implicit() for 'QType', Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 13/49] qapi: Avoid unwanted blank lines in QAPIDoc, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 25/49] qapi2texi: Don't hide undocumented members and arguments,
Markus Armbruster <=
- [Qemu-devel] [PULL for 2.9 30/49] qapi2texi: Generate descriptions for simple union tags, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 41/49] qapi: Drop unused variable events, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 31/49] qapi2texi: Use category "Object" for all object types, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 35/49] qapi: Improve error message on @NAME: in free-form doc, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 22/49] qapi2texi: Plainer enum value and member name formatting, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 33/49] qapi: Fix detection of doc / expression mismatch, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 23/49] qapi2texi: Present the table of members more clearly, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 36/49] qapi: Move empty doc section checking to doc parser, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 42/49] qapi: Simplify what gets stored in enum_types, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 34/49] qapi: Move detection of doc / expression name mismatch, Markus Armbruster, 2017/03/16