mirror of
https://github.com/qemu/qemu.git
synced 2025-08-17 07:16:28 +00:00
8d789c8cdb
Thanks for your service!
Remove the old qapidoc and the option to enable the transmogrifier,
leaving the "transmogrifier" as the ONLY qapi doc generator. This in
effect also converts the QAPI test to use the new documentation
generator, too.
Update doc-good.txt output to match the new doc generator, which I
should've done exactly when we switched over to the transmogrifier, but,
uhh, oops!
Notes on the new format:
1. per-member IFCOND documentation is missing. Known issue.
2. Freeform documentation without a header is now copied through into
the output. This is a bug fix.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-ID: <20250618165353.1980365-4-jsnow@redhat.com>
Acked-by: Markus Armbruster <armbru@redhat.com>
Fixes: b61a4eb3f3 (docs/qapidoc: support header-less freeform sections)
[Tweak commit message to say it's a bug fix, add Fixes:]
Signed-off-by: Markus Armbruster <armbru@redhat.com>
182 lines
2.9 KiB
Plaintext
182 lines
2.9 KiB
Plaintext
Section
|
|
*******
|
|
|
|
Just text, no heading.
|
|
|
|
|
|
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
|
|
*Availability*: "IFCOND"
|
|
|
|
Values:
|
|
* **one** -- The _one_ {and only}, description on the same line
|
|
|
|
* **two** -- Not documented
|
|
|
|
Features:
|
|
* **enum-feat** -- Also _one_ {and only}
|
|
|
|
* **enum-member-feat** -- a member feature
|
|
|
|
"two" is undocumented
|
|
|
|
Object Base
|
|
*Availability*: "IFALL1 and IFALL2"
|
|
|
|
Members:
|
|
* **base1** ("Enum") -- description starts on a new line,
|
|
minimally indented
|
|
|
|
Object Variant1
|
|
|
|
A paragraph
|
|
|
|
Another paragraph
|
|
|
|
"var1" is undocumented
|
|
|
|
Members:
|
|
* **var1** ("string") -- Not documented
|
|
|
|
Features:
|
|
* **variant1-feat** -- a feature
|
|
|
|
* **member-feat** -- a member feature
|
|
|
|
Object Variant2
|
|
|
|
Object Object
|
|
|
|
Members:
|
|
* The members of "Base".
|
|
|
|
* When "base1" is "one": The members of "Variant1".
|
|
|
|
* When "base1" is "two": The members of "Variant2".
|
|
|
|
Features:
|
|
* **union-feat1** -- a feature
|
|
|
|
Alternate Alternate
|
|
*Availability*: "not (IFONE or IFTWO)"
|
|
|
|
Alternatives:
|
|
* **i** ("int") -- description starts on the same line remainder
|
|
indented the same "b" is undocumented
|
|
|
|
* **b** ("boolean") -- Not documented
|
|
|
|
Features:
|
|
* **alt-feat** -- a feature
|
|
|
|
|
|
Another subsection
|
|
==================
|
|
|
|
Command cmd (Since: 2.10)
|
|
|
|
Arguments:
|
|
* **arg1** ("int") -- description starts on a new line, indented
|
|
|
|
* **arg2** ("string", *optional*) -- description starts on the
|
|
same line remainder indented differently
|
|
|
|
* **arg3** ("boolean") -- Not documented
|
|
|
|
Features:
|
|
* **cmd-feat1** -- a feature
|
|
|
|
* **cmd-feat2** -- another feature
|
|
|
|
Note:
|
|
|
|
"arg3" is undocumented
|
|
|
|
Return:
|
|
"Object" -- "Object"
|
|
|
|
Errors:
|
|
some
|
|
|
|
Notes:
|
|
|
|
* Lorem ipsum dolor sit amet
|
|
|
|
* Ut enim ad minim veniam
|
|
|
|
Duis aute irure dolor
|
|
|
|
Example: Ideal fast-food burger situation:
|
|
|
|
-> "in"
|
|
<- "out"
|
|
|
|
Examples:
|
|
|
|
- Not a QMP code block
|
|
- Merely a preformatted code block literal
|
|
It isn't even an rST list.
|
|
- *verbatim*
|
|
- {braces}
|
|
|
|
Note::
|
|
Ceci n'est pas une note
|
|
|
|
Command cmd-boxed
|
|
|
|
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::
|
|
|
|
-> "this example"
|
|
|
|
<- ... has no title ...
|
|
|
|
Event EVT_BOXED
|
|
|
|
Members:
|
|
* The members of "Object".
|
|
|
|
Features:
|
|
* **feat3** -- a feature
|