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= Section 59doc freeform 60 body= 61Just text, no heading. 62doc freeform 63 body= 64== Subsection 65 66*with emphasis* 67@var {in braces} 68 69* List item one 70* Two, multiple 71 lines 72 73* Three 74 Still in list 75 76Not in list 77 78- Second list 79 Note: still in list 80 81Note: not in list 82 831. Third list 84 is numbered 85 862. another item 87 88Returns: the King 89Since: the first age 90Notes: 91 921. Lorem ipsum dolor sit amet 93 942. Ut enim ad minim veniam 95 96Duis aute irure dolor 97 98Example: 99 100-> in 101<- out 102Examples: 103- *verbatim* 104- {braces} 105doc symbol=Enum 106 body= 107 108 arg=one 109The _one_ {and only}, description on the same line 110 arg=two 111 112 feature=enum-feat 113Also _one_ {and only} 114 feature=enum-member-feat 115a member feature 116 section=Plain 117@two is undocumented 118doc symbol=Base 119 body= 120 121 arg=base1 122 description starts on a new line, 123 minimally indented 124doc symbol=Variant1 125 body= 126A paragraph 127 128Another paragraph 129 130@var1 is undocumented 131 arg=var1 132 133 feature=variant1-feat 134a feature 135 feature=member-feat 136a member feature 137doc symbol=Variant2 138 body= 139 140doc symbol=Object 141 body= 142 143 feature=union-feat1 144a feature 145doc symbol=Alternate 146 body= 147 148 arg=i 149description starts on the same line 150 remainder indented the same 151 @b is undocumented 152 arg=b 153 154 feature=alt-feat 155a feature 156doc freeform 157 body= 158== Another subsection 159doc symbol=cmd 160 body= 161 162 arg=arg1 163 description starts on a new line, 164 indented 165 arg=arg2 166description starts on the same line 167 remainder indented differently 168 arg=arg3 169 170 feature=cmd-feat1 171a feature 172 feature=cmd-feat2 173another feature 174 section=Plain 175.. note:: @arg3 is undocumented 176 section=Returns 177@Object 178 section=Errors 179some 180 section=Todo 181frobnicate 182 section=Plain 183.. admonition:: Notes 184 185 - Lorem ipsum dolor sit amet 186 - Ut enim ad minim veniam 187 188 Duis aute irure dolor 189 190.. qmp-example:: 191 :title: Ideal fast-food burger situation 192 193 -> "in" 194 <- "out" 195 196Examples:: 197 198 - Not a QMP code block 199 - Merely a preformatted code block literal 200 It isn't even an rST list. 201 - *verbatim* 202 - {braces} 203 204Note:: 205 Ceci n'est pas une note 206 section=Since 2072.10 208doc symbol=cmd-boxed 209 body= 210If you're bored enough to read this, go see a video of boxed cats 211 feature=cmd-feat1 212a feature 213 feature=cmd-feat2 214another feature 215 section=Plain 216.. qmp-example:: 217 218 -> "this example" 219 220 <- ... has no title ... 221doc symbol=EVT_BOXED 222 body= 223 224 feature=feat3 225a feature 226