diff options
| author | Markus Armbruster <armbru@redhat.com> | 2019-10-24 13:02:24 +0200 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2019-10-29 07:35:16 +0100 |
| commit | b621a26040dd626cf9098c277e763f55fcfacf67 (patch) | |
| tree | 67f26deea46e75c69a38865c448d84eab17ae9fe /tests/qapi-schema | |
| parent | 6d570ca10e3d7c628cdb5d8b8b5ea4fd3b994d9f (diff) | |
| download | qemu-b621a26040dd626cf9098c277e763f55fcfacf67.zip qemu-b621a26040dd626cf9098c277e763f55fcfacf67.tar.gz qemu-b621a26040dd626cf9098c277e763f55fcfacf67.tar.bz2 | |
qapi: Implement boxed event argument documentation
Generate a reference "Arguments: the members of ...", just like we do
for commands since commit c2dd311cb7 "qapi2texi: Implement boxed
argument documentation".
No change to generated QMP documentation; we don't yet use boxed
events outside tests/.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20191024110237.30963-7-armbru@redhat.com>
Diffstat (limited to 'tests/qapi-schema')
| -rw-r--r-- | tests/qapi-schema/doc-good.json | 1 | ||||
| -rw-r--r-- | tests/qapi-schema/doc-good.out | 2 | ||||
| -rw-r--r-- | tests/qapi-schema/doc-good.texi | 4 |
3 files changed, 4 insertions, 3 deletions
diff --git a/tests/qapi-schema/doc-good.json b/tests/qapi-schema/doc-good.json index df50a87..d992e71 100644 --- a/tests/qapi-schema/doc-good.json +++ b/tests/qapi-schema/doc-good.json @@ -160,7 +160,6 @@ ## # @EVT-BOXED: -# BUG: generated doc misses arguments ## { 'event': 'EVT-BOXED', 'boxed': true, 'data': 'Object' } diff --git a/tests/qapi-schema/doc-good.out b/tests/qapi-schema/doc-good.out index 8cc29fc..4c9406a 100644 --- a/tests/qapi-schema/doc-good.out +++ b/tests/qapi-schema/doc-good.out @@ -196,4 +196,4 @@ another feature <- out doc symbol=EVT-BOXED body= -BUG: generated doc misses arguments + diff --git a/tests/qapi-schema/doc-good.texi b/tests/qapi-schema/doc-good.texi index 98aa78e1..d4b15da 100644 --- a/tests/qapi-schema/doc-good.texi +++ b/tests/qapi-schema/doc-good.texi @@ -279,7 +279,9 @@ another feature @deftypefn Event {} EVT-BOXED -BUG: generated doc misses arguments + + +@b{Arguments:} the members of @code{Object} @end deftypefn |