tests/qapi-schema: Cover alternate documentation comments

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20191024110237.30963-4-armbru@redhat.com>
This commit is contained in:
Markus Armbruster 2019-10-24 13:02:21 +02:00
parent 717cfcfae6
commit f6401deb06
3 changed files with 37 additions and 0 deletions

View File

@ -98,6 +98,14 @@
{ 'union': 'SugaredUnion', { 'union': 'SugaredUnion',
'data': { 'one': 'Variant1', 'two': { 'type': 'Variant2', 'if': 'IFTWO' } } } 'data': { 'one': 'Variant1', 'two': { 'type': 'Variant2', 'if': 'IFTWO' } } }
##
# @Alternate:
# @i: an integer
# @b is undocumented
##
{ 'alternate': 'Alternate',
'data': { 'i': 'int', 'b': 'bool' } }
## ##
# == Another subsection # == Another subsection
## ##

View File

@ -42,6 +42,10 @@ object SugaredUnion
case one: q_obj_Variant1-wrapper case one: q_obj_Variant1-wrapper
case two: q_obj_Variant2-wrapper case two: q_obj_Variant2-wrapper
if ['IFTWO'] if ['IFTWO']
alternate Alternate
tag type
case i: int
case b: bool
object q_obj_cmd-arg object q_obj_cmd-arg
member arg1: int optional=False member arg1: int optional=False
member arg2: str optional=True member arg2: str optional=True
@ -133,6 +137,14 @@ doc symbol=SugaredUnion
arg=type arg=type
doc symbol=Alternate
body=
arg=i
an integer
@b is undocumented
arg=b
doc freeform doc freeform
body= body=
== Another subsection == Another subsection

View File

@ -170,6 +170,23 @@ One of @t{"one"}, @t{"two"}
@end deftp @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 @subsection Another subsection