commit 691e03133e79fd1f70ea4b524cdd10cbc23fd72a
author Markus Armbruster <armbru@redhat.com> Wed Mar 15 13:57:14 2017 +0100
committer Markus Armbruster <armbru@redhat.com> Thu Mar 16 07:13:03 2017 +0100
tree eeb20596e51ec9d2b56f0c2543218ae6eb4a21e3
parent c2dd311cb72b0ef59287aad3c0c7ee968c7289e2

qapi2texi: Include member type in generated documentation

The recent merge of docs/qmp-commands.txt and docs/qmp-events.txt into
the schema lost type information.  Fix this documentation regression.

Example change (qemu-qmp-ref.txt):

  -- Struct: InputKeyEvent

      Keyboard input event.

      Members:
-     'button'
+     'button: InputButton'
           Which button this event is for.
-     'down'
+     'down: boolean'
           True for key-down and false for key-up events.

      Since: 2.0

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Message-Id: <1489582656-31133-26-git-send-email-armbru@redhat.com>

scripts/qapi.py

diff --git a/scripts/qapi.py b/scripts/qapi.py
index 8b7377e..21a1591 100644
--- a/scripts/qapi.py
+++ b/scripts/qapi.py
@@ -1105,6 +1105,11 @@
         }
         return json2qtype.get(self.json_type())
 
+    def doc_type(self):
+        if self.is_implicit():
+            return None
+        return self.name
+
 
 class QAPISchemaBuiltinType(QAPISchemaType):
     def __init__(self, name, json_type, c_type):
@@ -1129,6 +1134,9 @@
     def json_type(self):
         return self._json_type_name
 
+    def doc_type(self):
+        return self.json_type()
+
     def visit(self, visitor):
         visitor.visit_builtin_type(self.name, self.info, self.json_type())
 
@@ -1188,6 +1196,12 @@
     def json_type(self):
         return 'array'
 
+    def doc_type(self):
+        elt_doc_type = self.element_type.doc_type()
+        if not elt_doc_type:
+            return None
+        return 'array of ' + elt_doc_type
+
     def visit(self, visitor):
         visitor.visit_array_type(self.name, self.info, self.element_type)