qemu/tests/qapi-schema/doc-good.txt
Markus Armbruster b6c18755e4 qapi: Add feature flags to enum members
This is quite similar to commit 84ab008687 "qapi: Add feature flags to
struct members", only for enums instead of structs.

Special feature flag 'deprecated' is silently ignored there.  This is
okay only because it will be implemented shortly.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Message-Id: <20211025042405.3762351-3-armbru@redhat.com>
Reviewed-by: John Snow <jsnow@redhat.com>
2021-10-27 17:18:55 +02:00

285 lines
2.5 KiB
Plaintext

Section
*******
Subsection
==========
*with emphasis* "var" {in braces}
* List item one
* Two, multiple lines
* Three Still in list
Not in list
* Second list Note: still in list
Note: not in list
1. Third list is numbered
2. another item
Returns: the King Since: the first age Notes:
1. Lorem ipsum dolor sit amet
2. Ut enim ad minim veniam
Duis aute irure dolor
Example:
-> in <- out Examples: - *verbatim* - {braces}
"Enum" (Enum)
-------------
Values
~~~~~~
"one" (**If: **"IFONE")
The _one_ {and only}
"two"
Not documented
Features
~~~~~~~~
"enum-feat"
Also _one_ {and only}
"enum-member-feat"
a member feature
"two" is undocumented
If
~~
"IFCOND"
"Base" (Object)
---------------
Members
~~~~~~~
"base1": "Enum"
the first member
If
~~
"IFALL1 and IFALL2"
"Variant1" (Object)
-------------------
A paragraph
Another paragraph (but no "var": line)
Members
~~~~~~~
"var1": "string" (**If: **"IFSTR")
Not documented
Features
~~~~~~~~
"variant1-feat"
a feature
"member-feat"
a member feature
"Variant2" (Object)
-------------------
"Object" (Object)
-----------------
Members
~~~~~~~
The members of "Base"
The members of "Variant1" when "base1" is ""one""
The members of "Variant2" when "base1" is ""two"" (**If: **"IFONE or
IFTWO")
Features
~~~~~~~~
"union-feat1"
a feature
"Alternate" (Alternate)
-----------------------
Members
~~~~~~~
"i": "int"
an integer "b" is undocumented
"b": "boolean"
Not documented
Features
~~~~~~~~
"alt-feat"
a feature
If
~~
"not (IFONE or IFTWO)"
Another subsection
==================
"cmd" (Command)
---------------
Arguments
~~~~~~~~~
"arg1": "int"
the first argument
"arg2": "string" (optional)
the second argument
"arg3": "boolean"
Not documented
Features
~~~~~~~~
"cmd-feat1"
a feature
"cmd-feat2"
another feature
Note
~~~~
"arg3" is undocumented
Returns
~~~~~~~
"Object"
TODO
~~~~
frobnicate
Notes
~~~~~
* Lorem ipsum dolor sit amet
* Ut enim ad minim veniam
Duis aute irure dolor
Example
~~~~~~~
-> in
<- out
Examples
~~~~~~~~
- *verbatim*
- {braces}
Since
~~~~~
2.10
"cmd-boxed" (Command)
---------------------
If you're bored enough to read this, go see a video of boxed cats
Arguments
~~~~~~~~~
The members of "Object"
Features
~~~~~~~~
"cmd-feat1"
a feature
"cmd-feat2"
another feature
Example
~~~~~~~
-> in
<- out
"EVT_BOXED" (Event)
-------------------
Arguments
~~~~~~~~~
The members of "Object"
Features
~~~~~~~~
"feat3"
a feature