diff options
author | Markus Armbruster <armbru@redhat.com> | 2019-10-24 13:02:21 +0200 |
---|---|---|
committer | Markus Armbruster <armbru@redhat.com> | 2019-10-29 07:35:16 +0100 |
commit | f6401deb067457119278586fbb2a0c283382cfa4 (patch) | |
tree | 41ab73e1a458cbe3ab02811842288e5e65449d12 /tests/qapi-schema | |
parent | 717cfcfae6df46c82b1ae191ec7ae6e0e288c914 (diff) | |
download | qemu-f6401deb067457119278586fbb2a0c283382cfa4.zip qemu-f6401deb067457119278586fbb2a0c283382cfa4.tar.gz qemu-f6401deb067457119278586fbb2a0c283382cfa4.tar.bz2 |
tests/qapi-schema: Cover alternate documentation comments
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20191024110237.30963-4-armbru@redhat.com>
Diffstat (limited to 'tests/qapi-schema')
-rw-r--r-- | tests/qapi-schema/doc-good.json | 8 | ||||
-rw-r--r-- | tests/qapi-schema/doc-good.out | 12 | ||||
-rw-r--r-- | tests/qapi-schema/doc-good.texi | 17 |
3 files changed, 37 insertions, 0 deletions
diff --git a/tests/qapi-schema/doc-good.json b/tests/qapi-schema/doc-good.json index 1ae6c3a..df50a87 100644 --- a/tests/qapi-schema/doc-good.json +++ b/tests/qapi-schema/doc-good.json @@ -99,6 +99,14 @@ 'data': { 'one': 'Variant1', 'two': { 'type': 'Variant2', 'if': 'IFTWO' } } } ## +# @Alternate: +# @i: an integer +# @b is undocumented +## +{ 'alternate': 'Alternate', + 'data': { 'i': 'int', 'b': 'bool' } } + +## # == Another subsection ## diff --git a/tests/qapi-schema/doc-good.out b/tests/qapi-schema/doc-good.out index a8fc39d..b0e99f2 100644 --- a/tests/qapi-schema/doc-good.out +++ b/tests/qapi-schema/doc-good.out @@ -42,6 +42,10 @@ object SugaredUnion case one: q_obj_Variant1-wrapper case two: q_obj_Variant2-wrapper if ['IFTWO'] +alternate Alternate + tag type + case i: int + case b: bool object q_obj_cmd-arg member arg1: int optional=False member arg2: str optional=True @@ -133,6 +137,14 @@ doc symbol=SugaredUnion arg=type +doc symbol=Alternate + body= + + arg=i +an integer +@b is undocumented + arg=b + doc freeform body= == Another subsection diff --git a/tests/qapi-schema/doc-good.texi b/tests/qapi-schema/doc-good.texi index d6ecdac..98aa78e1 100644 --- a/tests/qapi-schema/doc-good.texi +++ b/tests/qapi-schema/doc-good.texi @@ -170,6 +170,23 @@ One of @t{"one"}, @t{"two"} @end deftp + +@deftp {Alternate} Alternate + + + +@b{Members:} +@table @asis +@item @code{i: int} +an integer +@code{b} is undocumented +@item @code{b: boolean} +Not documented +@end table + +@end deftp + + @subsection Another subsection |