]>
Commit | Line | Data |
---|---|---|
8a84767c MA |
1 | object q_empty |
2 | enum QType ['none', 'qnull', 'qnum', 'qstring', 'qdict', 'qlist', 'qbool'] | |
3 | prefix QTYPE | |
cf40a0a5 | 4 | module doc-good.json |
8a84767c | 5 | enum Enum ['one', 'two'] |
901a34a4 | 6 | if ['defined(IFCOND)'] |
80d1f2e4 MA |
7 | object Base |
8 | member base1: Enum optional=False | |
8a84767c MA |
9 | object Variant1 |
10 | member var1: str optional=False | |
11 | object Variant2 | |
80d1f2e4 MA |
12 | object Object |
13 | base Base | |
14 | tag base1 | |
15 | case one: Variant1 | |
16 | case two: Variant2 | |
8a84767c MA |
17 | object q_obj_Variant1-wrapper |
18 | member data: Variant1 optional=False | |
19 | object q_obj_Variant2-wrapper | |
20 | member data: Variant2 optional=False | |
21 | enum SugaredUnionKind ['one', 'two'] | |
80d1f2e4 MA |
22 | object SugaredUnion |
23 | member type: SugaredUnionKind optional=False | |
24 | tag type | |
25 | case one: q_obj_Variant1-wrapper | |
26 | case two: q_obj_Variant2-wrapper | |
80d1f2e4 MA |
27 | object q_obj_cmd-arg |
28 | member arg1: int optional=False | |
29 | member arg2: str optional=True | |
30 | member arg3: bool optional=False | |
8a84767c | 31 | command cmd q_obj_cmd-arg -> Object |
7b13f2c2 | 32 | gen=True success_response=True boxed=False oob=False preconfig=False |
8a84767c | 33 | command cmd-boxed Object -> None |
7b13f2c2 | 34 | gen=True success_response=True boxed=True oob=False preconfig=False |
80d1f2e4 MA |
35 | doc freeform |
36 | body= | |
37 | = Section | |
38 | ||
39 | == Subsection | |
40 | ||
41 | *strong* _with emphasis_ | |
42 | @var {in braces} | |
43 | * List item one | |
44 | - Two, multiple | |
45 | lines | |
46 | ||
47 | 3. Three | |
48 | Still in list | |
49 | ||
50 | Not in list | |
51 | - Second list | |
52 | Note: still in list | |
53 | ||
54 | Note: not in list | |
55 | 1. Third list | |
56 | is numbered | |
57 | ||
58 | - another item | |
59 | ||
60 | | example | |
61 | | multiple lines | |
62 | ||
63 | Returns: the King | |
64 | Since: the first age | |
65 | Notes: | |
66 | ||
67 | 1. Lorem ipsum dolor sit amet | |
68 | ||
69 | 2. Ut enim ad minim veniam | |
70 | ||
71 | Duis aute irure dolor | |
72 | ||
73 | Example: | |
74 | ||
75 | -> in | |
76 | <- out | |
77 | Examples: | |
78 | - *verbatim* | |
79 | - {braces} | |
80 | doc symbol=Enum | |
81 | body= | |
cfa438ff | 82 | |
80d1f2e4 MA |
83 | arg=one |
84 | The _one_ {and only} | |
85 | arg=two | |
86 | ||
fc3f0df1 | 87 | section=None |
80d1f2e4 MA |
88 | @two is undocumented |
89 | doc symbol=Base | |
90 | body= | |
91 | ||
92 | arg=base1 | |
93 | the first member | |
94 | doc symbol=Variant1 | |
95 | body= | |
96 | A paragraph | |
97 | ||
98 | Another paragraph (but no @var: line) | |
99 | arg=var1 | |
100 | ||
101 | doc symbol=Variant2 | |
102 | body= | |
103 | ||
104 | doc symbol=Object | |
105 | body= | |
106 | ||
107 | doc symbol=SugaredUnion | |
108 | body= | |
109 | ||
110 | arg=type | |
111 | ||
112 | doc freeform | |
113 | body= | |
114 | == Another subsection | |
115 | doc symbol=cmd | |
116 | body= | |
117 | ||
118 | arg=arg1 | |
119 | the first argument | |
120 | arg=arg2 | |
121 | the second | |
122 | argument | |
123 | arg=arg3 | |
124 | ||
125 | section=Note | |
126 | @arg3 is undocumented | |
127 | section=Returns | |
128 | @Object | |
129 | section=TODO | |
130 | frobnicate | |
131 | section=Notes | |
132 | - Lorem ipsum dolor sit amet | |
133 | - Ut enim ad minim veniam | |
134 | ||
135 | Duis aute irure dolor | |
136 | section=Example | |
137 | -> in | |
138 | <- out | |
139 | section=Examples | |
140 | - *verbatim* | |
141 | - {braces} | |
142 | section=Since | |
143 | 2.10 | |
144 | doc symbol=cmd-boxed | |
145 | body= | |
146 | If you're bored enough to read this, go see a video of boxed cats | |
147 | section=Example | |
148 | -> in | |
149 | ||
150 | <- out |