| 1 | module ./builtin |
| 2 | object q_empty |
| 3 | enum QType |
| 4 | member none |
| 5 | member qnull |
| 6 | member qnum |
| 7 | member qstring |
| 8 | member qdict |
| 9 | member qlist |
| 10 | member qbool |
| 11 | module doc-good.json |
| 12 | enum Enum |
| 13 | member one |
| 14 | if IFONE |
| 15 | feature enum-member-feat |
| 16 | member two |
| 17 | if IFCOND |
| 18 | feature enum-feat |
| 19 | object Base |
| 20 | member base1: Enum optional=False |
| 21 | if {'all': ['IFALL1', 'IFALL2']} |
| 22 | object Variant1 |
| 23 | member var1: str optional=False |
| 24 | if IFSTR |
| 25 | feature member-feat |
| 26 | feature variant1-feat |
| 27 | object Variant2 |
| 28 | object Object |
| 29 | base Base |
| 30 | tag base1 |
| 31 | case one: Variant1 |
| 32 | case two: Variant2 |
| 33 | if {'any': ['IFONE', 'IFTWO']} |
| 34 | feature union-feat1 |
| 35 | alternate Alternate |
| 36 | tag type |
| 37 | case i: int |
| 38 | case b: bool |
| 39 | if {'not': {'any': ['IFONE', 'IFTWO']}} |
| 40 | feature alt-feat |
| 41 | object q_obj_cmd-arg |
| 42 | member arg1: int optional=False |
| 43 | member arg2: str optional=True |
| 44 | member arg3: bool optional=False |
| 45 | command cmd q_obj_cmd-arg -> Object |
| 46 | gen=True success_response=True boxed=False oob=False preconfig=False |
| 47 | feature cmd-feat1 |
| 48 | feature cmd-feat2 |
| 49 | command cmd-boxed Object -> None |
| 50 | gen=True success_response=True boxed=True oob=False preconfig=False |
| 51 | feature cmd-feat1 |
| 52 | feature cmd-feat2 |
| 53 | event EVT_BOXED Object |
| 54 | boxed=True |
| 55 | feature feat3 |
| 56 | doc freeform |
| 57 | Plain |
| 58 | ******* |
| 59 | Section |
| 60 | ******* |
| 61 | doc freeform |
| 62 | Plain |
| 63 | Just text, no heading. |
| 64 | doc freeform |
| 65 | Plain |
| 66 | Subsection |
| 67 | ========== |
| 68 | |
| 69 | *with emphasis* |
| 70 | @var {in braces} |
| 71 | |
| 72 | * List item one |
| 73 | * Two, multiple |
| 74 | lines |
| 75 | |
| 76 | * Three |
| 77 | Still in list |
| 78 | |
| 79 | Not in list |
| 80 | |
| 81 | - Second list |
| 82 | Note: still in list |
| 83 | |
| 84 | Note: not in list |
| 85 | |
| 86 | 1. Third list |
| 87 | is numbered |
| 88 | |
| 89 | 2. another item |
| 90 | |
| 91 | Returns: the King |
| 92 | Since: the first age |
| 93 | Notes: |
| 94 | |
| 95 | 1. Lorem ipsum dolor sit amet |
| 96 | |
| 97 | 2. Ut enim ad minim veniam |
| 98 | |
| 99 | Duis aute irure dolor |
| 100 | |
| 101 | Example: |
| 102 | |
| 103 | -> in |
| 104 | <- out |
| 105 | Examples: |
| 106 | - *verbatim* |
| 107 | - {braces} |
| 108 | doc symbol=Enum |
| 109 | Intro |
| 110 | |
| 111 | Member=one |
| 112 | The _one_ {and only}, description on the same line |
| 113 | Member=two |
| 114 | |
| 115 | Feature=enum-feat |
| 116 | Also _one_ {and only} |
| 117 | Feature=enum-member-feat |
| 118 | a member feature |
| 119 | Plain |
| 120 | @two is undocumented |
| 121 | doc symbol=Base |
| 122 | Intro |
| 123 | |
| 124 | Member=base1 |
| 125 | description starts on a new line, |
| 126 | minimally indented |
| 127 | doc symbol=Variant1 |
| 128 | Intro |
| 129 | |
| 130 | Plain |
| 131 | A paragraph |
| 132 | |
| 133 | Another paragraph |
| 134 | |
| 135 | @var1 is undocumented |
| 136 | Member=var1 |
| 137 | |
| 138 | Feature=variant1-feat |
| 139 | a feature |
| 140 | Feature=member-feat |
| 141 | a member feature |
| 142 | doc symbol=Variant2 |
| 143 | Intro |
| 144 | |
| 145 | doc symbol=Object |
| 146 | Intro |
| 147 | |
| 148 | Feature=union-feat1 |
| 149 | a feature |
| 150 | doc symbol=Alternate |
| 151 | Intro |
| 152 | |
| 153 | Member=i |
| 154 | description starts on the same line |
| 155 | remainder indented the same |
| 156 | @b is undocumented |
| 157 | Member=b |
| 158 | |
| 159 | Feature=alt-feat |
| 160 | a feature |
| 161 | doc freeform |
| 162 | Plain |
| 163 | Another subsection |
| 164 | ================== |
| 165 | doc symbol=cmd |
| 166 | Intro |
| 167 | |
| 168 | Member=arg1 |
| 169 | description starts on a new line, |
| 170 | indented |
| 171 | Member=arg2 |
| 172 | description starts on the same line |
| 173 | remainder indented differently |
| 174 | Member=arg3 |
| 175 | |
| 176 | Feature=cmd-feat1 |
| 177 | a feature |
| 178 | Feature=cmd-feat2 |
| 179 | another feature |
| 180 | Plain |
| 181 | .. note:: @arg3 is undocumented |
| 182 | Returns |
| 183 | @Object |
| 184 | Errors |
| 185 | some |
| 186 | Todo |
| 187 | frobnicate |
| 188 | Plain |
| 189 | .. admonition:: Notes |
| 190 | |
| 191 | - Lorem ipsum dolor sit amet |
| 192 | - Ut enim ad minim veniam |
| 193 | |
| 194 | Duis aute irure dolor |
| 195 | |
| 196 | .. qmp-example:: |
| 197 | :title: Ideal fast-food burger situation |
| 198 | |
| 199 | -> "in" |
| 200 | <- "out" |
| 201 | |
| 202 | Examples:: |
| 203 | |
| 204 | - Not a QMP code block |
| 205 | - Merely a preformatted code block literal |
| 206 | It isn't even an rST list. |
| 207 | - *verbatim* |
| 208 | - {braces} |
| 209 | |
| 210 | Note:: |
| 211 | Ceci n'est pas une note |
| 212 | Since |
| 213 | 2.10 |
| 214 | doc symbol=cmd-boxed |
| 215 | Intro |
| 216 | |
| 217 | Plain |
| 218 | If you're bored enough to read this, go see a video of boxed cats |
| 219 | Feature=cmd-feat1 |
| 220 | a feature |
| 221 | Feature=cmd-feat2 |
| 222 | another feature |
| 223 | Plain |
| 224 | .. qmp-example:: |
| 225 | |
| 226 | -> "this example" |
| 227 | |
| 228 | <- ... has no title ... |
| 229 | doc symbol=EVT_BOXED |
| 230 | Intro |
| 231 | |
| 232 | Feature=feat3 |
| 233 | a feature |