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
63 # @one: The _one_ {and only}, description on the same line
66 # @enum-feat: Also _one_ {and only}
67 # @enum-member-feat: a member feature
69 # @two is undocumented
72 'data': [ { 'name': 'one', 'if': 'IFONE',
73 'features': [ 'enum-member-feat' ] },
75 'features': [ 'enum-feat' ],
82 # description starts on a new line,
85 { 'struct': 'Base', 'data': { 'base1': 'Enum' },
86 'if': { 'all': ['IFALL1', 'IFALL2'] } }
95 # @var1 is undocumented
98 # @variant1-feat: a feature
99 # @member-feat: a member feature
101 { 'struct': 'Variant1',
102 'features': [ 'variant1-feat' ],
103 'data': { 'var1': { 'type': 'str',
104 'features': [ 'member-feat' ],
111 { 'struct': 'Variant2', 'data': {} }
117 # @union-feat1: a feature
120 'features': [ 'union-feat1' ],
122 'discriminator': 'base1',
123 'data': { 'one': 'Variant1',
124 'two': { 'type': 'Variant2',
125 'if': { 'any': ['IFONE', 'IFTWO'] } } } }
130 # @i: description starts on the same line
131 # remainder indented the same
135 # @alt-feat: a feature
137 { 'alternate': 'Alternate',
138 'features': [ 'alt-feat' ],
139 'data': { 'i': 'int', 'b': 'bool' },
140 'if': { 'not': { 'any': [ 'IFONE', 'IFTWO' ] } } }
143 # == Another subsection
150 # description starts on a new line,
153 # @arg2: description starts on the same line
154 # remainder indented differently
157 # @cmd-feat1: a feature
158 # @cmd-feat2: another feature
160 # .. note:: @arg3 is undocumented
168 # .. admonition:: Notes
170 # - Lorem ipsum dolor sit amet
171 # - Ut enim ad minim veniam
173 # Duis aute irure dolor
176 # :title: Ideal fast-food burger situation
183 # - Not a QMP code block
184 # - Merely a preformatted code block literal
185 # It isn't even an rST list.
190 # Ceci n'est pas une note
195 'data': { 'arg1': 'int', '*arg2': 'str', 'arg3': 'bool' },
197 'features': [ 'cmd-feat1', 'cmd-feat2' ] }
201 # If you're bored enough to read this, go see a video of boxed cats
204 # @cmd-feat1: a feature
205 # @cmd-feat2: another feature
213 { 'command': 'cmd-boxed', 'boxed': true,
215 'features': [ 'cmd-feat1', 'cmd-feat2' ] }
223 { 'event': 'EVT_BOXED', 'boxed': true,
224 'features': [ 'feat3' ],