4 # Positive QAPI doc comment tests
8 'documentation-exceptions': [ 'Enum', 'Variant1', 'Alternate', 'cmd' ] } }
40 # Since: the first age
43 # 1. Lorem ipsum dolor sit amet
45 # 2. Ut enim ad minim veniam
47 # Duis aute irure dolor
61 # @one: The _one_ {and only}, description on the same line
64 # @enum-feat: Also _one_ {and only}
65 # @enum-member-feat: a member feature
67 # @two is undocumented
70 'data': [ { 'name': 'one', 'if': 'IFONE',
71 'features': [ 'enum-member-feat' ] },
73 'features': [ 'enum-feat' ],
80 # description starts on a new line,
83 { 'struct': 'Base', 'data': { 'base1': 'Enum' },
84 'if': { 'all': ['IFALL1', 'IFALL2'] } }
93 # @var1 is undocumented
96 # @variant1-feat: a feature
97 # @member-feat: a member feature
99 { 'struct': 'Variant1',
100 'features': [ 'variant1-feat' ],
101 'data': { 'var1': { 'type': 'str',
102 'features': [ 'member-feat' ],
109 { 'struct': 'Variant2', 'data': {} }
115 # @union-feat1: a feature
118 'features': [ 'union-feat1' ],
120 'discriminator': 'base1',
121 'data': { 'one': 'Variant1',
122 'two': { 'type': 'Variant2',
123 'if': { 'any': ['IFONE', 'IFTWO'] } } } }
128 # @i: description starts on the same line
129 # remainder indented the same
133 # @alt-feat: a feature
135 { 'alternate': 'Alternate',
136 'features': [ 'alt-feat' ],
137 'data': { 'i': 'int', 'b': 'bool' },
138 'if': { 'not': { 'any': [ 'IFONE', 'IFTWO' ] } } }
141 # == Another subsection
148 # description starts on a new line,
151 # @arg2: description starts on the same line
152 # remainder indented differently
155 # @cmd-feat1: a feature
156 # @cmd-feat2: another feature
158 # Note: @arg3 is undocumented
168 # - Lorem ipsum dolor sit amet
169 # - Ut enim ad minim veniam
171 # Duis aute irure dolor
185 'data': { 'arg1': 'int', '*arg2': 'str', 'arg3': 'bool' },
187 'features': [ 'cmd-feat1', 'cmd-feat2' ] }
191 # If you're bored enough to read this, go see a video of boxed cats
194 # @cmd-feat1: a feature
195 # @cmd-feat2: another feature
203 { 'command': 'cmd-boxed', 'boxed': true,
205 'features': [ 'cmd-feat1', 'cmd-feat2' ] }
213 { 'event': 'EVT_BOXED', 'boxed': true,
214 'features': [ 'feat3' ],