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