mirror of
https://github.com/qemu/qemu.git
synced 2026-07-08 17:46:10 +00:00
ebb49d4bb6
Add parsing for explicit Intro section syntax. A side effect of this patch is that we will (currently) always create an empty Intro section, similar to how we used to have an empty Plain section. The tests are adjusted accordingly, rendered document output does not change at all. Signed-off-by: John Snow <jsnow@redhat.com> Message-ID: <20260611042332.482979-14-jsnow@redhat.com> Reviewed-by: Markus Armbruster <armbru@redhat.com> [Commit message tweaked] Signed-off-by: Markus Armbruster <armbru@redhat.com>
234 lines
3.7 KiB
Plaintext
234 lines
3.7 KiB
Plaintext
module ./builtin
|
|
object q_empty
|
|
enum QType
|
|
member none
|
|
member qnull
|
|
member qnum
|
|
member qstring
|
|
member qdict
|
|
member qlist
|
|
member qbool
|
|
module doc-good.json
|
|
enum Enum
|
|
member one
|
|
if IFONE
|
|
feature enum-member-feat
|
|
member two
|
|
if IFCOND
|
|
feature enum-feat
|
|
object Base
|
|
member base1: Enum optional=False
|
|
if {'all': ['IFALL1', 'IFALL2']}
|
|
object Variant1
|
|
member var1: str optional=False
|
|
if IFSTR
|
|
feature member-feat
|
|
feature variant1-feat
|
|
object Variant2
|
|
object Object
|
|
base Base
|
|
tag base1
|
|
case one: Variant1
|
|
case two: Variant2
|
|
if {'any': ['IFONE', 'IFTWO']}
|
|
feature union-feat1
|
|
alternate Alternate
|
|
tag type
|
|
case i: int
|
|
case b: bool
|
|
if {'not': {'any': ['IFONE', 'IFTWO']}}
|
|
feature alt-feat
|
|
object q_obj_cmd-arg
|
|
member arg1: int optional=False
|
|
member arg2: str optional=True
|
|
member arg3: bool optional=False
|
|
command cmd q_obj_cmd-arg -> Object
|
|
gen=True success_response=True boxed=False oob=False preconfig=False
|
|
feature cmd-feat1
|
|
feature cmd-feat2
|
|
command cmd-boxed Object -> None
|
|
gen=True success_response=True boxed=True oob=False preconfig=False
|
|
feature cmd-feat1
|
|
feature cmd-feat2
|
|
event EVT_BOXED Object
|
|
boxed=True
|
|
feature feat3
|
|
doc freeform
|
|
Plain
|
|
*******
|
|
Section
|
|
*******
|
|
doc freeform
|
|
Plain
|
|
Just text, no heading.
|
|
doc freeform
|
|
Plain
|
|
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}
|
|
doc symbol=Enum
|
|
Intro
|
|
|
|
Member=one
|
|
The _one_ {and only}, description on the same line
|
|
Member=two
|
|
|
|
Feature=enum-feat
|
|
Also _one_ {and only}
|
|
Feature=enum-member-feat
|
|
a member feature
|
|
Plain
|
|
@two is undocumented
|
|
doc symbol=Base
|
|
Intro
|
|
|
|
Member=base1
|
|
description starts on a new line,
|
|
minimally indented
|
|
doc symbol=Variant1
|
|
Intro
|
|
|
|
Plain
|
|
A paragraph
|
|
|
|
Another paragraph
|
|
|
|
@var1 is undocumented
|
|
Member=var1
|
|
|
|
Feature=variant1-feat
|
|
a feature
|
|
Feature=member-feat
|
|
a member feature
|
|
doc symbol=Variant2
|
|
Intro
|
|
|
|
doc symbol=Object
|
|
Intro
|
|
|
|
Feature=union-feat1
|
|
a feature
|
|
doc symbol=Alternate
|
|
Intro
|
|
|
|
Member=i
|
|
description starts on the same line
|
|
remainder indented the same
|
|
@b is undocumented
|
|
Member=b
|
|
|
|
Feature=alt-feat
|
|
a feature
|
|
doc freeform
|
|
Plain
|
|
Another subsection
|
|
==================
|
|
doc symbol=cmd
|
|
Intro
|
|
|
|
Member=arg1
|
|
description starts on a new line,
|
|
indented
|
|
Member=arg2
|
|
description starts on the same line
|
|
remainder indented differently
|
|
Member=arg3
|
|
|
|
Feature=cmd-feat1
|
|
a feature
|
|
Feature=cmd-feat2
|
|
another feature
|
|
Plain
|
|
.. note:: @arg3 is undocumented
|
|
Returns
|
|
@Object
|
|
Errors
|
|
some
|
|
Todo
|
|
frobnicate
|
|
Plain
|
|
.. admonition:: Notes
|
|
|
|
- Lorem ipsum dolor sit amet
|
|
- Ut enim ad minim veniam
|
|
|
|
Duis aute irure dolor
|
|
|
|
.. qmp-example::
|
|
:title: 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
|
|
Since
|
|
2.10
|
|
doc symbol=cmd-boxed
|
|
Intro
|
|
|
|
Plain
|
|
If you're bored enough to read this, go see a video of boxed cats
|
|
Feature=cmd-feat1
|
|
a feature
|
|
Feature=cmd-feat2
|
|
another feature
|
|
Plain
|
|
.. qmp-example::
|
|
|
|
-> "this example"
|
|
|
|
<- ... has no title ...
|
|
doc symbol=EVT_BOXED
|
|
Intro
|
|
|
|
Feature=feat3
|
|
a feature
|