doc-good.out 2.6 KB
Newer Older
1
object q_empty
2
enum QType
3
    prefix QTYPE
4 5 6 7 8 9 10
    member none
    member qnull
    member qnum
    member qstring
    member qdict
    member qlist
    member qbool
11
module doc-good.json
12 13
enum Enum
    member one
14
        if ['defined(IFONE)']
15
    member two
16
    if ['defined(IFCOND)']
17 18
object Base
    member base1: Enum optional=False
19 20
object Variant1
    member var1: str optional=False
21
        if ['defined(IFSTR)']
22
object Variant2
23 24 25 26 27
object Object
    base Base
    tag base1
    case one: Variant1
    case two: Variant2
28
        if ['IFTWO']
29 30 31 32
object q_obj_Variant1-wrapper
    member data: Variant1 optional=False
object q_obj_Variant2-wrapper
    member data: Variant2 optional=False
33 34 35
enum SugaredUnionKind
    member one
    member two
36
        if ['IFTWO']
37 38 39 40 41
object SugaredUnion
    member type: SugaredUnionKind optional=False
    tag type
    case one: q_obj_Variant1-wrapper
    case two: q_obj_Variant2-wrapper
42
        if ['IFTWO']
43 44 45 46
object q_obj_cmd-arg
    member arg1: int optional=False
    member arg2: str optional=True
    member arg3: bool optional=False
47
command cmd q_obj_cmd-arg -> Object
48
   gen=True success_response=True boxed=False oob=False preconfig=False
49
command cmd-boxed Object -> None
50
   gen=True success_response=True boxed=True oob=False preconfig=False
51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97
doc freeform
    body=
= Section

== Subsection

*strong* _with emphasis_
@var {in braces}
* List item one
- Two, multiple
lines

3. Three
Still in list

Not in list
- Second list
Note: still in list

Note: not in list
1. Third list
is numbered

- another item

| example
| multiple lines

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
    body=
98

99 100 101 102
    arg=one
The _one_ {and only}
    arg=two

103
    section=None
104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166
@two is undocumented
doc symbol=Base
    body=

    arg=base1
the first member
doc symbol=Variant1
    body=
A paragraph

Another paragraph (but no @var: line)
    arg=var1

doc symbol=Variant2
    body=

doc symbol=Object
    body=

doc symbol=SugaredUnion
    body=

    arg=type

doc freeform
    body=
== Another subsection
doc symbol=cmd
    body=

    arg=arg1
the first argument
    arg=arg2
the second
argument
    arg=arg3

    section=Note
@arg3 is undocumented
    section=Returns
@Object
    section=TODO
frobnicate
    section=Notes
- Lorem ipsum dolor sit amet
- Ut enim ad minim veniam

Duis aute irure dolor
    section=Example
-> in
<- out
    section=Examples
- *verbatim*
- {braces}
    section=Since
2.10
doc symbol=cmd-boxed
    body=
If you're bored enough to read this, go see a video of boxed cats
    section=Example
-> in

<- out