testproject.html 70 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209
  1. <?xml version="1.0" encoding="utf-8" ?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <!-- This file is generated by Nim. -->
  4. <html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  5. <head>
  6. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  7. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  8. <title>testproject</title>
  9. <!-- Favicon -->
  10. <link rel="shortcut icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAUAAAAF////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAIAAABbAAAAlQAAAKIAAACbAAAAmwAAAKIAAACVAAAAWwAAAAL///8A////AP///wD///8A////AAAAABQAAADAAAAAYwAAAA3///8A////AP///wD///8AAAAADQAAAGMAAADAAAAAFP///wD///8A////AP///wAAAACdAAAAOv///wD///8A////AP///wD///8A////AP///wD///8AAAAAOgAAAJ3///8A////AP///wAAAAAnAAAAcP///wAAAAAoAAAASv///wD///8A////AP///wAAAABKAAAAKP///wAAAABwAAAAJ////wD///8AAAAAgQAAABwAAACIAAAAkAAAAJMAAACtAAAAFQAAABUAAACtAAAAkwAAAJAAAACIAAAAHAAAAIH///8A////AAAAAKQAAACrAAAAaP///wD///8AAAAARQAAANIAAADSAAAARf///wD///8AAAAAaAAAAKsAAACk////AAAAADMAAACcAAAAnQAAABj///8A////AP///wAAAAAYAAAAGP///wD///8A////AAAAABgAAACdAAAAnAAAADMAAAB1AAAAwwAAAP8AAADpAAAAsQAAAE4AAAAb////AP///wAAAAAbAAAATgAAALEAAADpAAAA/wAAAMMAAAB1AAAAtwAAAOkAAAD/AAAA/wAAAP8AAADvAAAA3gAAAN4AAADeAAAA3gAAAO8AAAD/AAAA/wAAAP8AAADpAAAAtwAAAGUAAAA/AAAA3wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAADfAAAAPwAAAGX///8A////AAAAAEgAAADtAAAAvwAAAL0AAADGAAAA7wAAAO8AAADGAAAAvQAAAL8AAADtAAAASP///wD///8A////AP///wD///8AAAAAO////wD///8A////AAAAAIcAAACH////AP///wD///8AAAAAO////wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A//8AAP//AAD4HwAA7/cAAN/7AAD//wAAoYUAAJ55AACf+QAAh+EAAAAAAADAAwAA4AcAAP5/AAD//wAA//8AAA=="/>
  11. <link rel="icon" type="image/png" sizes="32x32" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA3XAAAN1wFCKJt4AAAAB3RJTUUH4QQQEwksSS9ZWwAAAk1JREFUWMPtll2ITVEUx39nn/O7Y5qR8f05wtCUUr6ZIS++8pEnkZInPImneaCQ5METNdOkeFBKUhMPRIkHKfEuUZSUlGlKPN2TrgfncpvmnntnmlEyq1Z7t89/rf9a6+y99oZxGZf/XeIq61EdtgKXgdXA0xrYAvBjOIF1AI9zvjcC74BSpndrJPkBWDScTF8Aa4E3wDlgHbASaANmVqlcCnwHvgDvgVfAJ+AikAAvgfVZwLnSVZHZaOuKoQi3ZOMi4NkYkpe1p4J7A8BpYAD49hfIy/oqG0+hLomiKP2L5L+1ubn5115S+3OAn4EnwBlgMzCjyt6ZAnQCJ4A7wOs88iRJHvw50HoujuPBoCKwHWiosy8MdfZnAdcHk8dxXFJ3VQbQlCTJvRBCGdRbD4M6uc5glpY3eAihpN5S5w12diSEcCCEcKUO4ljdr15T76ur1FDDLIQQ3qv71EdDOe3Kxj3leRXyk+pxdWnFWod6Wt2bY3de3aSuUHcPBVimHs7mK9WrmeOF6lR1o9qnzskh2ar2qm1qizpfXaPeVGdlmGN5pb09qMxz1Xb1kLqgzn1RyH7JUXW52lr5e/Kqi9qpto7V1atuUzfnARrV7jEib1T76gG2qxdGmXyiekkt1GswPTtek0aBfJp6YySGBfWg2tPQ0FAYgf1stUfdmdcjarbYJEniKIq6gY/Aw+zWHAC+p2labGpqiorFYgGYCEzN7oQdQClN07O1/EfDyGgC0ALMBdYAi4FyK+4H3gLPsxfR1zRNi+NP7nH5J+QntnXe5B5mpfQAAAAASUVORK5CYII=">
  12. <!-- CSS -->
  13. <link rel="stylesheet" type="text/css" href="nimdoc.out.css">
  14. <!-- JS -->
  15. <script type="text/javascript" src="dochack.js"></script>
  16. </head>
  17. <body>
  18. <div class="document" id="documentId">
  19. <div class="container">
  20. <h1 class="title">testproject</h1>
  21. <div class="row">
  22. <div class="three columns">
  23. <div class="theme-select-wrapper">
  24. <label for="theme-select">Theme:&nbsp;</label>
  25. <select id="theme-select" onchange="setTheme(this.value)">
  26. <option value="auto">🌗 Match OS</option>
  27. <option value="dark">🌑 Dark</option>
  28. <option value="light">🌕 Light</option>
  29. </select>
  30. </div>
  31. <div id="global-links">
  32. <ul class="simple">
  33. <li><a id="indexLink" href="theindex.html">Index</a></li>
  34. </ul>
  35. </div>
  36. <div id="searchInputDiv">
  37. Search: <input type="search" id="searchInput" onkeyup="search()"/>
  38. </div>
  39. <div>
  40. Group by:
  41. <select onchange="groupBy(this.value)">
  42. <option value="section">Section</option>
  43. <option value="type">Type</option>
  44. </select>
  45. </div>
  46. <ul class="simple simple-toc" id="toc-list">
  47. <li>
  48. <a class="reference reference-toplevel" href="#6" id="56">Imports</a>
  49. </li>
  50. <li>
  51. <details open>
  52. <summary><a class="reference reference-toplevel" href="#7" id="57">Types</a></summary>
  53. <ul class="simple simple-toc-section">
  54. <li><a class="reference" href="#A" title="A {.inject.} = enum
  55. aA">A</a></li>
  56. <li><a class="reference" href="#B" title="B {.inject.} = enum
  57. bB">B</a></li>
  58. <li><a class="reference" href="#Foo" title="Foo = enum
  59. enumValueA2">Foo</a></li>
  60. <li><a class="reference" href="#FooBuzz" title="FooBuzz {.deprecated: &quot;FooBuzz msg&quot;.} = int">FooBuzz</a></li>
  61. <li><a class="reference" href="#Shapes" title="Shapes = enum
  62. Circle, ## A circle
  63. Triangle, ## A three-sided shape
  64. Rectangle ## A four-sided shape">Shapes</a></li>
  65. <li><a class="reference" href="#T19396" title="T19396 = object
  66. a*: int">T19396</a></li>
  67. </ul>
  68. </details>
  69. </li>
  70. <li>
  71. <details open>
  72. <summary><a class="reference reference-toplevel" href="#8" id="58">Vars</a></summary>
  73. <ul class="simple simple-toc-section">
  74. <li><a class="reference" href="#aVariable" title="aVariable: array[1, int]">aVariable</a></li>
  75. <li><a class="reference" href="#someVariable" title="someVariable: bool">someVariable</a></li>
  76. </ul>
  77. </details>
  78. </li>
  79. <li>
  80. <details open>
  81. <summary><a class="reference reference-toplevel" href="#10" id="60">Consts</a></summary>
  82. <ul class="simple simple-toc-section">
  83. <li><a class="reference" href="#C_A" title="C_A = 0x7FF0000000000000'f64">C_A</a></li>
  84. <li><a class="reference" href="#C_B" title="C_B = 0o377'i8">C_B</a></li>
  85. <li><a class="reference" href="#C_C" title="C_C = 0o277'i8">C_C</a></li>
  86. <li><a class="reference" href="#C_D" title="C_D = 0o177777'i16">C_D</a></li>
  87. </ul>
  88. </details>
  89. </li>
  90. <li>
  91. <details open>
  92. <summary><a class="reference reference-toplevel" href="#12" id="62">Procs</a></summary>
  93. <ul class="simple simple-toc-section">
  94. <ul class="simple nested-toc-section">addfBug14485
  95. <li><a class="reference" href="#addfBug14485" title="addfBug14485()">addfBug14485()</a></li>
  96. </ul>
  97. <ul class="simple nested-toc-section">anything
  98. <li><a class="reference" href="#anything" title="anything()">anything()</a></li>
  99. </ul>
  100. <ul class="simple nested-toc-section">asyncFun1
  101. <li><a class="reference" href="#asyncFun1" title="asyncFun1(): Future[int]">asyncFun1(): Future[int]</a></li>
  102. </ul>
  103. <ul class="simple nested-toc-section">asyncFun2
  104. <li><a class="reference" href="#asyncFun2" title="asyncFun2(): owned(Future[void])">asyncFun2(): owned(Future[void])</a></li>
  105. </ul>
  106. <ul class="simple nested-toc-section">asyncFun3
  107. <li><a class="reference" href="#asyncFun3" title="asyncFun3(): owned(Future[void])">asyncFun3(): owned(Future[void])</a></li>
  108. </ul>
  109. <ul class="simple nested-toc-section">bar
  110. <li><a class="reference" href="#bar" title="bar(f: FooBuzz)">bar(f: FooBuzz)</a></li>
  111. <li><a class="reference" href="#bar%2CT%2CT" title="bar[T](a, b: T): T">bar[T](a, b: T): T</a></li>
  112. </ul>
  113. <ul class="simple nested-toc-section">baz
  114. <li><a class="reference" href="#baz" title="baz()">baz()</a></li>
  115. <li><a class="reference" href="#baz%2CT%2CT" title="baz[T](a, b: T): T">baz[T](a, b: T): T</a></li>
  116. </ul>
  117. <ul class="simple nested-toc-section">buzz
  118. <li><a class="reference" href="#buzz%2CT%2CT" title="buzz[T](a, b: T): T">buzz[T](a, b: T): T</a></li>
  119. </ul>
  120. <ul class="simple nested-toc-section">c_nonexistent
  121. <li><a class="reference" href="#c_nonexistent%2Ccstring" title="c_nonexistent(frmt: cstring): cint">c_nonexistent(frmt: cstring): cint</a></li>
  122. </ul>
  123. <ul class="simple nested-toc-section">c_printf
  124. <li><a class="reference" href="#c_printf%2Ccstring" title="c_printf(frmt: cstring): cint">c_printf(frmt: cstring): cint</a></li>
  125. </ul>
  126. <ul class="simple nested-toc-section">fromUtils3
  127. <li><a class="reference" href="#fromUtils3" title="fromUtils3()">fromUtils3()</a></li>
  128. </ul>
  129. <ul class="simple nested-toc-section">isValid
  130. <li><a class="reference" href="#isValid%2CT" title="isValid[T](x: T): bool">isValid[T](x: T): bool</a></li>
  131. </ul>
  132. <ul class="simple nested-toc-section">low
  133. <li><a class="reference" href="#low%2CT" title="low[T: Ordinal | enum | range](x: T): T">low[T: Ordinal | enum | range](x: T): T</a></li>
  134. </ul>
  135. <ul class="simple nested-toc-section">low2
  136. <li><a class="reference" href="#low2%2CT" title="low2[T: Ordinal | enum | range](x: T): T">low2[T: Ordinal | enum | range](x: T): T</a></li>
  137. </ul>
  138. <ul class="simple nested-toc-section">p1
  139. <li><a class="reference" href="#p1" title="p1()">p1()</a></li>
  140. </ul>
  141. <ul class="simple nested-toc-section">someFunc
  142. <li><a class="reference" href="#someFunc" title="someFunc()">someFunc()</a></li>
  143. </ul>
  144. <ul class="simple nested-toc-section">tripleStrLitTest
  145. <li><a class="reference" href="#tripleStrLitTest" title="tripleStrLitTest()">tripleStrLitTest()</a></li>
  146. </ul>
  147. <ul class="simple nested-toc-section">z1
  148. <li><a class="reference" href="#z1" title="z1(): Foo">z1(): Foo</a></li>
  149. </ul>
  150. <ul class="simple nested-toc-section">z2
  151. <li><a class="reference" href="#z2" title="z2()">z2()</a></li>
  152. </ul>
  153. <ul class="simple nested-toc-section">z3
  154. <li><a class="reference" href="#z3" title="z3()">z3()</a></li>
  155. </ul>
  156. <ul class="simple nested-toc-section">z4
  157. <li><a class="reference" href="#z4" title="z4()">z4()</a></li>
  158. </ul>
  159. <ul class="simple nested-toc-section">z5
  160. <li><a class="reference" href="#z5" title="z5(): int">z5(): int</a></li>
  161. </ul>
  162. <ul class="simple nested-toc-section">z6
  163. <li><a class="reference" href="#z6" title="z6(): int">z6(): int</a></li>
  164. </ul>
  165. <ul class="simple nested-toc-section">z7
  166. <li><a class="reference" href="#z7" title="z7(): int">z7(): int</a></li>
  167. </ul>
  168. <ul class="simple nested-toc-section">z8
  169. <li><a class="reference" href="#z8" title="z8(): int">z8(): int</a></li>
  170. </ul>
  171. <ul class="simple nested-toc-section">z9
  172. <li><a class="reference" href="#z9" title="z9()">z9()</a></li>
  173. </ul>
  174. <ul class="simple nested-toc-section">z10
  175. <li><a class="reference" href="#z10" title="z10()">z10()</a></li>
  176. </ul>
  177. <ul class="simple nested-toc-section">z11
  178. <li><a class="reference" href="#z11" title="z11()">z11()</a></li>
  179. </ul>
  180. <ul class="simple nested-toc-section">z12
  181. <li><a class="reference" href="#z12" title="z12(): int">z12(): int</a></li>
  182. </ul>
  183. <ul class="simple nested-toc-section">z13
  184. <li><a class="reference" href="#z13" title="z13()">z13()</a></li>
  185. </ul>
  186. <ul class="simple nested-toc-section">z17
  187. <li><a class="reference" href="#z17" title="z17()">z17()</a></li>
  188. </ul>
  189. </ul>
  190. </details>
  191. </li>
  192. <li>
  193. <details open>
  194. <summary><a class="reference reference-toplevel" href="#14" id="64">Methods</a></summary>
  195. <ul class="simple simple-toc-section">
  196. <ul class="simple nested-toc-section">method1
  197. <li><a class="reference" href="#method1.e%2CMoo" title="method1(self: Moo)">method1(self: Moo)</a></li>
  198. </ul>
  199. <ul class="simple nested-toc-section">method2
  200. <li><a class="reference" href="#method2.e%2CMoo" title="method2(self: Moo): int">method2(self: Moo): int</a></li>
  201. </ul>
  202. <ul class="simple nested-toc-section">method3
  203. <li><a class="reference" href="#method3.e%2CMoo" title="method3(self: Moo): int">method3(self: Moo): int</a></li>
  204. </ul>
  205. </ul>
  206. </details>
  207. </li>
  208. <li>
  209. <details open>
  210. <summary><a class="reference reference-toplevel" href="#15" id="65">Iterators</a></summary>
  211. <ul class="simple simple-toc-section">
  212. <ul class="simple nested-toc-section">fromUtils1
  213. <li><a class="reference" href="#fromUtils1.i" title="fromUtils1(): int">fromUtils1(): int</a></li>
  214. </ul>
  215. <ul class="simple nested-toc-section">iter1
  216. <li><a class="reference" href="#iter1.i%2Cint" title="iter1(n: int): int">iter1(n: int): int</a></li>
  217. </ul>
  218. <ul class="simple nested-toc-section">iter2
  219. <li><a class="reference" href="#iter2.i%2Cint" title="iter2(n: int): int">iter2(n: int): int</a></li>
  220. </ul>
  221. </ul>
  222. </details>
  223. </li>
  224. <li>
  225. <details open>
  226. <summary><a class="reference reference-toplevel" href="#17" id="67">Macros</a></summary>
  227. <ul class="simple simple-toc-section">
  228. <ul class="simple nested-toc-section">bar
  229. <li><a class="reference" href="#bar.m" title="bar(): untyped">bar(): untyped</a></li>
  230. </ul>
  231. <ul class="simple nested-toc-section">z16
  232. <li><a class="reference" href="#z16.m" title="z16()">z16()</a></li>
  233. </ul>
  234. <ul class="simple nested-toc-section">z18
  235. <li><a class="reference" href="#z18.m" title="z18(): int">z18(): int</a></li>
  236. </ul>
  237. </ul>
  238. </details>
  239. </li>
  240. <li>
  241. <details open>
  242. <summary><a class="reference reference-toplevel" href="#18" id="68">Templates</a></summary>
  243. <ul class="simple simple-toc-section">
  244. <ul class="simple nested-toc-section">foo
  245. <li><a class="reference" href="#foo.t%2CSomeType%2CSomeType" title="foo(a, b: SomeType)">foo(a, b: SomeType)</a></li>
  246. </ul>
  247. <ul class="simple nested-toc-section">fromUtils2
  248. <li><a class="reference" href="#fromUtils2.t" title="fromUtils2()">fromUtils2()</a></li>
  249. </ul>
  250. <ul class="simple nested-toc-section">myfn
  251. <li><a class="reference" href="#myfn.t" title="myfn()">myfn()</a></li>
  252. </ul>
  253. <ul class="simple nested-toc-section">testNimDocTrailingExample
  254. <li><a class="reference" href="#testNimDocTrailingExample.t" title="testNimDocTrailingExample()">testNimDocTrailingExample()</a></li>
  255. </ul>
  256. <ul class="simple nested-toc-section">z6t
  257. <li><a class="reference" href="#z6t.t" title="z6t(): int">z6t(): int</a></li>
  258. </ul>
  259. <ul class="simple nested-toc-section">z14
  260. <li><a class="reference" href="#z14.t" title="z14()">z14()</a></li>
  261. </ul>
  262. <ul class="simple nested-toc-section">z15
  263. <li><a class="reference" href="#z15.t" title="z15()">z15()</a></li>
  264. </ul>
  265. </ul>
  266. </details>
  267. </li>
  268. </ul>
  269. </div>
  270. <div class="nine columns" id="content">
  271. <div id="tocRoot"></div>
  272. <p class="module-desc">This is the top level module.
  273. <p><strong class="examples_text">Example:</strong></p>
  274. <pre class="listing"><span class="Keyword">import</span> <span class="Identifier">testproject</span>
  275. <span class="Keyword">import</span> <span class="Identifier">subdir</span> <span class="Operator">/</span> <span class="Identifier">subdir_b</span> <span class="Operator">/</span> <span class="Identifier">utils</span>
  276. <span class="Identifier">doAssert</span> <span class="Identifier">bar</span><span class="Punctuation">(</span><span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">4</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">7</span>
  277. <span class="Identifier">foo</span><span class="Punctuation">(</span><span class="Identifier">enumValueA</span><span class="Punctuation">,</span> <span class="Identifier">enumValueB</span><span class="Punctuation">)</span>
  278. <span class="Comment"># bug #11078</span>
  279. <span class="Keyword">for</span> <span class="Identifier">x</span> <span class="Keyword">in</span> <span class="StringLit">&quot;xx&quot;</span><span class="Punctuation">:</span> <span class="Keyword">discard</span></pre>top2
  280. <p><strong class="examples_text">Example:</strong></p>
  281. <pre class="listing"><span class="Keyword">import</span> <span class="Identifier">testproject</span>
  282. <span class="Keyword">discard</span> <span class="StringLit">&quot;in top2&quot;</span></pre>top2 after
  283. <p><strong class="examples_text">Example:</strong></p>
  284. <pre class="listing"><span class="Keyword">import</span> <span class="Identifier">testproject</span>
  285. <span class="Keyword">discard</span> <span class="StringLit">&quot;in top3&quot;</span></pre>top3 after</p>
  286. <div class="section" id="6">
  287. <h1><a class="toc-backref" href="#6">Imports</a></h1>
  288. <dl class="item">
  289. <a class="reference external" href="subdir/subdir_b/utils.html">subdir/subdir_b/utils</a>
  290. </dl>
  291. </div>
  292. <div class="section" id="7">
  293. <h1><a class="toc-backref" href="#7">Types</a></h1>
  294. <dl class="item">
  295. <div id="A">
  296. <dt><pre><a href="testproject.html#A"><span class="Identifier">A</span></a> {.<span class="Identifier">inject</span>.} <span class="Other">=</span> <span class="Keyword">enum</span>
  297. <span class="Identifier">aA</span></pre></dt>
  298. <dd>
  299. The enum A.
  300. </dd>
  301. </div>
  302. <div id="B">
  303. <dt><pre><a href="testproject.html#B"><span class="Identifier">B</span></a> {.<span class="Identifier">inject</span>.} <span class="Other">=</span> <span class="Keyword">enum</span>
  304. <span class="Identifier">bB</span></pre></dt>
  305. <dd>
  306. The enum B.
  307. </dd>
  308. </div>
  309. <div id="Foo">
  310. <dt><pre><a href="testproject.html#Foo"><span class="Identifier">Foo</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
  311. <span class="Identifier">enumValueA2</span></pre></dt>
  312. <dd>
  313. </dd>
  314. </div>
  315. <div id="FooBuzz">
  316. <dt><pre><a href="testproject.html#FooBuzz"><span class="Identifier">FooBuzz</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">deprecated</span><span class="Other">:</span> <span class="StringLit">&quot;FooBuzz msg&quot;</span></span>.} <span class="Other">=</span> <span class="Identifier">int</span></pre></dt>
  317. <dd>
  318. <div class="deprecation-message">
  319. <b>Deprecated:</b> FooBuzz msg
  320. </div>
  321. </dd>
  322. </div>
  323. <div id="Shapes">
  324. <dt><pre><a href="testproject.html#Shapes"><span class="Identifier">Shapes</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
  325. <span class="Identifier">Circle</span><span class="Other">,</span> <span class="Comment">## A circle</span>
  326. <span class="Identifier">Triangle</span><span class="Other">,</span> <span class="Comment">## A three-sided shape</span>
  327. <span class="Identifier">Rectangle</span> <span class="Comment">## A four-sided shape</span></pre></dt>
  328. <dd>
  329. Some shapes.
  330. </dd>
  331. </div>
  332. <div id="T19396">
  333. <dt><pre><a href="testproject.html#T19396"><span class="Identifier">T19396</span></a> <span class="Other">=</span> <span class="Keyword">object</span>
  334. <span class="Identifier">a</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">int</span>
  335. </pre></dt>
  336. <dd>
  337. </dd>
  338. </div>
  339. </dl>
  340. </div>
  341. <div class="section" id="8">
  342. <h1><a class="toc-backref" href="#8">Vars</a></h1>
  343. <dl class="item">
  344. <div id="aVariable">
  345. <dt><pre><a href="testproject.html#aVariable"><span class="Identifier">aVariable</span></a><span class="Other">:</span> <span class="Identifier">array</span><span class="Other">[</span><span class="DecNumber">1</span><span class="Other">,</span> <span class="Identifier">int</span><span class="Other">]</span></pre></dt>
  346. <dd>
  347. </dd>
  348. </div>
  349. <div id="someVariable">
  350. <dt><pre><a href="testproject.html#someVariable"><span class="Identifier">someVariable</span></a><span class="Other">:</span> <span class="Identifier">bool</span></pre></dt>
  351. <dd>
  352. This should be visible.
  353. </dd>
  354. </div>
  355. </dl>
  356. </div>
  357. <div class="section" id="10">
  358. <h1><a class="toc-backref" href="#10">Consts</a></h1>
  359. <dl class="item">
  360. <div id="C_A">
  361. <dt><pre><a href="testproject.html#C_A"><span class="Identifier">C_A</span></a> <span class="Other">=</span> <span class="FloatNumber">0x7FF0000000000000'f64</span></pre></dt>
  362. <dd>
  363. </dd>
  364. </div>
  365. <div id="C_B">
  366. <dt><pre><a href="testproject.html#C_B"><span class="Identifier">C_B</span></a> <span class="Other">=</span> <span class="DecNumber">0o377'i8</span></pre></dt>
  367. <dd>
  368. </dd>
  369. </div>
  370. <div id="C_C">
  371. <dt><pre><a href="testproject.html#C_C"><span class="Identifier">C_C</span></a> <span class="Other">=</span> <span class="DecNumber">0o277'i8</span></pre></dt>
  372. <dd>
  373. </dd>
  374. </div>
  375. <div id="C_D">
  376. <dt><pre><a href="testproject.html#C_D"><span class="Identifier">C_D</span></a> <span class="Other">=</span> <span class="DecNumber">0o177777'i16</span></pre></dt>
  377. <dd>
  378. </dd>
  379. </div>
  380. </dl>
  381. </div>
  382. <div class="section" id="12">
  383. <h1><a class="toc-backref" href="#12">Procs</a></h1>
  384. <dl class="item">
  385. <div id="addfBug14485-procs-all">
  386. <div id="addfBug14485">
  387. <dt><pre><span class="Keyword">proc</span> <a href="#addfBug14485"><span class="Identifier">addfBug14485</span></a><span class="Other">(</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  388. <dd>
  389. Some proc
  390. <p><strong class="examples_text">Example:</strong></p>
  391. <pre class="listing"><span class="Keyword">discard</span> <span class="StringLit">&quot;foo() = &quot;</span> <span class="Operator">&amp;</span> <span class="Operator">$</span><span class="Punctuation">[</span><span class="DecNumber">1</span><span class="Punctuation">]</span>
  392. <span class="LongComment">#[
  393. 0: let's also add some broken html to make sure this won't break in future
  394. 1: &lt;/span&gt;
  395. 2: &lt;/span&gt;
  396. 3: &lt;/span
  397. 4: &lt;/script&gt;
  398. 5: &lt;/script
  399. 6: &lt;/script
  400. 7: end of broken html
  401. ]#</span></pre>
  402. </dd>
  403. </div>
  404. </div>
  405. <div id="anything-procs-all">
  406. <div id="anything">
  407. <dt><pre><span class="Keyword">proc</span> <a href="#anything"><span class="Identifier">anything</span></a><span class="Other">(</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  408. <dd>
  409. There is no block quote after blank lines at the beginning.
  410. </dd>
  411. </div>
  412. </div>
  413. <div id="asyncFun1-procs-all">
  414. <div id="asyncFun1">
  415. <dt><pre><span class="Keyword">proc</span> <a href="#asyncFun1"><span class="Identifier">asyncFun1</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">int</span><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span>
  416. <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">Exception</span><span class="Other">,</span> <span class="Identifier">ValueError</span><span class="Other">]</span><span class="Other">,</span>
  417. <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  418. <dd>
  419. ok1
  420. </dd>
  421. </div>
  422. </div>
  423. <div id="asyncFun2-procs-all">
  424. <div id="asyncFun2">
  425. <dt><pre><span class="Keyword">proc</span> <a href="#asyncFun2"><span class="Identifier">asyncFun2</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">owned</span><span class="Other">(</span><span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">Exception</span><span class="Other">]</span><span class="Other">,</span>
  426. <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  427. <dd>
  428. </dd>
  429. </div>
  430. </div>
  431. <div id="asyncFun3-procs-all">
  432. <div id="asyncFun3">
  433. <dt><pre><span class="Keyword">proc</span> <a href="#asyncFun3"><span class="Identifier">asyncFun3</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">owned</span><span class="Other">(</span><span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">Exception</span><span class="Other">]</span><span class="Other">,</span>
  434. <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  435. <dd>
  436. <p><strong class="examples_text">Example:</strong></p>
  437. <pre class="listing"><span class="Keyword">discard</span></pre>ok1
  438. </dd>
  439. </div>
  440. </div>
  441. <div id="bar-procs-all">
  442. <div id="bar">
  443. <dt><pre><span class="Keyword">proc</span> <a href="#bar"><span class="Identifier">bar</span></a><span class="Other">(</span><span class="Identifier">f</span><span class="Other">:</span> <a href="testproject.html#FooBuzz"><span class="Identifier">FooBuzz</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  444. <dd>
  445. </dd>
  446. </div>
  447. <div id="bar,T,T">
  448. <dt><pre><span class="Keyword">proc</span> <a href="#bar%2CT%2CT"><span class="Identifier">bar</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">a</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span></pre></dt>
  449. <dd>
  450. </dd>
  451. </div>
  452. </div>
  453. <div id="baz-procs-all">
  454. <div id="baz">
  455. <dt><pre><span class="Keyword">proc</span> <a href="#baz"><span class="Identifier">baz</span></a><span class="Other">(</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  456. <dd>
  457. </dd>
  458. </div>
  459. <div id="baz,T,T">
  460. <dt><pre><span class="Keyword">proc</span> <a href="#baz%2CT%2CT"><span class="Identifier">baz</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">a</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">deprecated</span></span>.}</pre></dt>
  461. <dd>
  462. <div class="deprecation-message">
  463. <b>Deprecated</b>
  464. </div>
  465. This is deprecated without message.
  466. </dd>
  467. </div>
  468. </div>
  469. <div id="buzz-procs-all">
  470. <div id="buzz,T,T">
  471. <dt><pre><span class="Keyword">proc</span> <a href="#buzz%2CT%2CT"><span class="Identifier">buzz</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">a</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">deprecated</span><span class="Other">:</span> <span class="StringLit">&quot;since v0.20&quot;</span></span>.}</pre></dt>
  472. <dd>
  473. <div class="deprecation-message">
  474. <b>Deprecated:</b> since v0.20
  475. </div>
  476. This is deprecated with a message.
  477. </dd>
  478. </div>
  479. </div>
  480. <div id="c_nonexistent-procs-all">
  481. <div id="c_nonexistent,cstring">
  482. <dt><pre><span class="Keyword">proc</span> <a href="#c_nonexistent%2Ccstring"><span class="Identifier">c_nonexistent</span></a><span class="Other">(</span><span class="Identifier">frmt</span><span class="Other">:</span> <span class="Identifier">cstring</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cint</span> {.<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">&quot;nonexistent&quot;</span><span class="Other">,</span>
  483. <span class="Identifier">header</span><span class="Other">:</span> <span class="StringLit">&quot;&lt;stdio.h&gt;&quot;</span><span class="Other">,</span> <span class="Identifier">varargs</span><span class="Other">,</span> <span class="Identifier">discardable</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  484. <dd>
  485. </dd>
  486. </div>
  487. </div>
  488. <div id="c_printf-procs-all">
  489. <div id="c_printf,cstring">
  490. <dt><pre><span class="Keyword">proc</span> <a href="#c_printf%2Ccstring"><span class="Identifier">c_printf</span></a><span class="Other">(</span><span class="Identifier">frmt</span><span class="Other">:</span> <span class="Identifier">cstring</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cint</span> {.<span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">&quot;printf&quot;</span><span class="Other">,</span> <span class="Identifier">header</span><span class="Other">:</span> <span class="StringLit">&quot;&lt;stdio.h&gt;&quot;</span><span class="Other">,</span>
  491. <span class="Identifier">varargs</span><span class="Other">,</span> <span class="Identifier">discardable</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
  492. <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  493. <dd>
  494. the c printf. etc.
  495. </dd>
  496. </div>
  497. </div>
  498. <div id="fromUtils3-procs-all">
  499. <div id="fromUtils3">
  500. <dt><pre><span class="Keyword">proc</span> <a href="#fromUtils3"><span class="Identifier">fromUtils3</span></a><span class="Other">(</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  501. <dd>
  502. came form utils but should be shown where <tt class="docutils literal"><span class="pre"><span class="Identifier">fromUtilsGen</span></span></tt> is called
  503. <p><strong class="examples_text">Example:</strong></p>
  504. <pre class="listing"><span class="Keyword">discard</span> <span class="LongStringLit">&quot;&quot;&quot;should be shown as examples for fromUtils3
  505. in module calling fromUtilsGen&quot;&quot;&quot;</span></pre>
  506. </dd>
  507. </div>
  508. </div>
  509. <div id="isValid-procs-all">
  510. <div id="isValid,T">
  511. <dt><pre><span class="Keyword">proc</span> <a href="#isValid%2CT"><span class="Identifier">isValid</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">bool</span></pre></dt>
  512. <dd>
  513. </dd>
  514. </div>
  515. </div>
  516. <div id="low-procs-all">
  517. <div id="low,T">
  518. <dt><pre><span class="Keyword">proc</span> <a href="#low%2CT"><span class="Identifier">low</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">Ordinal</span> <span class="Operator">|</span> <span class="Keyword">enum</span> <span class="Operator">|</span> <span class="Identifier">range</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">&quot;Low&quot;</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
  519. <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  520. <dd>
  521. <p>Returns the lowest possible value of an ordinal value <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>. As a special semantic rule, <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> may also be a type identifier.</p>
  522. <p>See also:</p>
  523. <ul class="simple"><li><a class="reference external" href="#low2,T">low2(T)</a></li>
  524. </ul>
  525. <pre class="listing"><span class="Identifier">low</span><span class="Punctuation">(</span><span class="DecNumber">2</span><span class="Punctuation">)</span> <span class="Comment"># =&gt; -9223372036854775808</span></pre>
  526. </dd>
  527. </div>
  528. </div>
  529. <div id="low2-procs-all">
  530. <div id="low2,T">
  531. <dt><pre><span class="Keyword">proc</span> <a href="#low2%2CT"><span class="Identifier">low2</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">Ordinal</span> <span class="Operator">|</span> <span class="Keyword">enum</span> <span class="Operator">|</span> <span class="Identifier">range</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">&quot;Low&quot;</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
  532. <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  533. <dd>
  534. <p>Returns the lowest possible value of an ordinal value <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>. As a special semantic rule, <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> may also be a type identifier.</p>
  535. <p>See also:</p>
  536. <ul class="simple"><li><a class="reference external" href="#low,T">low(T)</a></li>
  537. </ul>
  538. <pre class="listing"><span class="Identifier">low2</span><span class="Punctuation">(</span><span class="DecNumber">2</span><span class="Punctuation">)</span> <span class="Comment"># =&gt; -9223372036854775808</span></pre>
  539. <p><strong class="examples_text">Example:</strong></p>
  540. <pre class="listing"><span class="Keyword">discard</span> <span class="StringLit">&quot;in low2&quot;</span></pre>
  541. </dd>
  542. </div>
  543. </div>
  544. <div id="p1-procs-all">
  545. <div id="p1">
  546. <dt><pre><span class="Keyword">proc</span> <a href="#p1"><span class="Identifier">p1</span></a><span class="Other">(</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  547. <dd>
  548. cp1
  549. <p><strong class="examples_text">Example:</strong></p>
  550. <pre class="listing"><span class="Identifier">doAssert</span> <span class="DecNumber">1</span> <span class="Operator">==</span> <span class="DecNumber">1</span> <span class="Comment"># regular comments work here</span></pre>c4
  551. <p><strong class="examples_text">Example:</strong></p>
  552. <pre class="listing"><span class="Comment"># c5 regular comments before 1st token work</span>
  553. <span class="Comment"># regular comment</span>
  554. <span class="LongComment">#[
  555. nested regular comment
  556. ]#</span>
  557. <span class="Identifier">doAssert</span> <span class="DecNumber">2</span> <span class="Operator">==</span> <span class="DecNumber">2</span> <span class="Comment"># c8</span>
  558. <span class="Comment">## this is a non-nested doc comment</span>
  559. <span class="LongComment">##[
  560. this is a nested doc comment
  561. ]##</span>
  562. <span class="Keyword">discard</span> <span class="StringLit">&quot;c9&quot;</span>
  563. <span class="Comment"># also work after</span></pre>
  564. </dd>
  565. </div>
  566. </div>
  567. <div id="someFunc-procs-all">
  568. <div id="someFunc">
  569. <dt><pre><span class="Keyword">func</span> <a href="#someFunc"><span class="Identifier">someFunc</span></a><span class="Other">(</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  570. <dd>
  571. My someFunc. Stuff in <tt class="docutils literal"><span class="pre"><span class="Identifier">quotes</span></span></tt> here. <a class="reference external" href="https://nim-lang.org">Some link</a>
  572. </dd>
  573. </div>
  574. </div>
  575. <div id="tripleStrLitTest-procs-all">
  576. <div id="tripleStrLitTest">
  577. <dt><pre><span class="Keyword">proc</span> <a href="#tripleStrLitTest"><span class="Identifier">tripleStrLitTest</span></a><span class="Other">(</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  578. <dd>
  579. <p><strong class="examples_text">Example: cmd: --hint:XDeclaredButNotUsed:off</strong></p>
  580. <pre class="listing"><span class="Comment">## mullitline string litterals are tricky as their indentation can span</span>
  581. <span class="Comment">## below that of the runnableExamples</span>
  582. <span class="Keyword">let</span> <span class="Identifier">s1a</span> <span class="Operator">=</span> <span class="LongStringLit">&quot;&quot;&quot;
  583. should appear at indent 0
  584. at indent 2
  585. at indent 0
  586. &quot;&quot;&quot;</span>
  587. <span class="Comment"># make sure this works too</span>
  588. <span class="Keyword">let</span> <span class="Identifier">s1b</span> <span class="Operator">=</span> <span class="LongStringLit">&quot;&quot;&quot;start at same line
  589. at indent 2
  590. at indent 0
  591. &quot;&quot;&quot;</span> <span class="Comment"># comment after</span>
  592. <span class="Keyword">let</span> <span class="Identifier">s2</span> <span class="Operator">=</span> <span class="LongStringLit">&quot;&quot;&quot;sandwich &quot;&quot;&quot;</span>
  593. <span class="Keyword">let</span> <span class="Identifier">s3</span> <span class="Operator">=</span> <span class="LongStringLit">&quot;&quot;&quot;&quot;&quot;&quot;</span>
  594. <span class="Keyword">when</span> <span class="Identifier">false</span><span class="Punctuation">:</span>
  595. <span class="Keyword">let</span> <span class="Identifier">s5</span> <span class="Operator">=</span> <span class="LongStringLit">&quot;&quot;&quot;
  596. in s5 &quot;&quot;&quot;</span>
  597. <span class="Keyword">let</span> <span class="Identifier">s3b</span> <span class="Operator">=</span> <span class="Punctuation">[</span><span class="LongStringLit">&quot;&quot;&quot;
  598. %!? #[...] # inside a multiline ...
  599. &quot;&quot;&quot;</span><span class="Punctuation">,</span> <span class="StringLit">&quot;foo&quot;</span><span class="Punctuation">]</span>
  600. <span class="Comment">## make sure handles trailing spaces</span>
  601. <span class="Keyword">let</span> <span class="Identifier">s4</span> <span class="Operator">=</span> <span class="LongStringLit">&quot;&quot;&quot;
  602. &quot;&quot;&quot;</span>
  603. <span class="Keyword">let</span> <span class="Identifier">s5</span> <span class="Operator">=</span> <span class="LongStringLit">&quot;&quot;&quot; x
  604. &quot;&quot;&quot;</span>
  605. <span class="Keyword">let</span> <span class="Identifier">s6</span> <span class="Operator">=</span> <span class="LongStringLit">&quot;&quot;&quot; &quot;&quot;
  606. &quot;&quot;&quot;</span>
  607. <span class="Keyword">let</span> <span class="Identifier">s7</span> <span class="Operator">=</span> <span class="LongStringLit">&quot;&quot;&quot;&quot;&quot;&quot;&quot;&quot;&quot;&quot;</span>
  608. <span class="Keyword">let</span> <span class="Identifier">s8</span> <span class="Operator">=</span> <span class="Punctuation">[</span><span class="LongStringLit">&quot;&quot;&quot;&quot;&quot;&quot;&quot;&quot;&quot;&quot;</span><span class="Punctuation">,</span> <span class="LongStringLit">&quot;&quot;&quot;
  609. &quot;&quot;&quot;</span> <span class="Punctuation">]</span>
  610. <span class="Keyword">discard</span>
  611. <span class="Comment"># should be in</span></pre>
  612. </dd>
  613. </div>
  614. </div>
  615. <div id="z1-procs-all">
  616. <div id="z1">
  617. <dt><pre><span class="Keyword">proc</span> <a href="#z1"><span class="Identifier">z1</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="testproject.html#Foo"><span class="Identifier">Foo</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  618. <dd>
  619. cz1
  620. </dd>
  621. </div>
  622. </div>
  623. <div id="z2-procs-all">
  624. <div id="z2">
  625. <dt><pre><span class="Keyword">proc</span> <a href="#z2"><span class="Identifier">z2</span></a><span class="Other">(</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  626. <dd>
  627. cz2
  628. <p><strong class="examples_text">Example:</strong></p>
  629. <pre class="listing"><span class="Keyword">discard</span> <span class="StringLit">&quot;in cz2&quot;</span></pre>
  630. </dd>
  631. </div>
  632. </div>
  633. <div id="z3-procs-all">
  634. <div id="z3">
  635. <dt><pre><span class="Keyword">proc</span> <a href="#z3"><span class="Identifier">z3</span></a><span class="Other">(</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  636. <dd>
  637. cz3
  638. </dd>
  639. </div>
  640. </div>
  641. <div id="z4-procs-all">
  642. <div id="z4">
  643. <dt><pre><span class="Keyword">proc</span> <a href="#z4"><span class="Identifier">z4</span></a><span class="Other">(</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  644. <dd>
  645. cz4
  646. </dd>
  647. </div>
  648. </div>
  649. <div id="z5-procs-all">
  650. <div id="z5">
  651. <dt><pre><span class="Keyword">proc</span> <a href="#z5"><span class="Identifier">z5</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">int</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  652. <dd>
  653. cz5
  654. </dd>
  655. </div>
  656. </div>
  657. <div id="z6-procs-all">
  658. <div id="z6">
  659. <dt><pre><span class="Keyword">proc</span> <a href="#z6"><span class="Identifier">z6</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">int</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  660. <dd>
  661. cz6
  662. </dd>
  663. </div>
  664. </div>
  665. <div id="z7-procs-all">
  666. <div id="z7">
  667. <dt><pre><span class="Keyword">proc</span> <a href="#z7"><span class="Identifier">z7</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">int</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  668. <dd>
  669. cz7
  670. </dd>
  671. </div>
  672. </div>
  673. <div id="z8-procs-all">
  674. <div id="z8">
  675. <dt><pre><span class="Keyword">proc</span> <a href="#z8"><span class="Identifier">z8</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">int</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  676. <dd>
  677. cz8
  678. </dd>
  679. </div>
  680. </div>
  681. <div id="z9-procs-all">
  682. <div id="z9">
  683. <dt><pre><span class="Keyword">proc</span> <a href="#z9"><span class="Identifier">z9</span></a><span class="Other">(</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  684. <dd>
  685. <p><strong class="examples_text">Example:</strong></p>
  686. <pre class="listing"><span class="Identifier">doAssert</span> <span class="DecNumber">1</span> <span class="Operator">+</span> <span class="DecNumber">1</span> <span class="Operator">==</span> <span class="DecNumber">2</span></pre>
  687. </dd>
  688. </div>
  689. </div>
  690. <div id="z10-procs-all">
  691. <div id="z10">
  692. <dt><pre><span class="Keyword">proc</span> <a href="#z10"><span class="Identifier">z10</span></a><span class="Other">(</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  693. <dd>
  694. <p><strong class="examples_text">Example: cmd: -d:foobar</strong></p>
  695. <pre class="listing"><span class="Keyword">discard</span> <span class="DecNumber">1</span></pre>cz10
  696. </dd>
  697. </div>
  698. </div>
  699. <div id="z11-procs-all">
  700. <div id="z11">
  701. <dt><pre><span class="Keyword">proc</span> <a href="#z11"><span class="Identifier">z11</span></a><span class="Other">(</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  702. <dd>
  703. <p><strong class="examples_text">Example:</strong></p>
  704. <pre class="listing"><span class="Keyword">discard</span> <span class="DecNumber">1</span></pre>
  705. </dd>
  706. </div>
  707. </div>
  708. <div id="z12-procs-all">
  709. <div id="z12">
  710. <dt><pre><span class="Keyword">proc</span> <a href="#z12"><span class="Identifier">z12</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">int</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  711. <dd>
  712. <p><strong class="examples_text">Example:</strong></p>
  713. <pre class="listing"><span class="Keyword">discard</span> <span class="DecNumber">1</span></pre>
  714. </dd>
  715. </div>
  716. </div>
  717. <div id="z13-procs-all">
  718. <div id="z13">
  719. <dt><pre><span class="Keyword">proc</span> <a href="#z13"><span class="Identifier">z13</span></a><span class="Other">(</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  720. <dd>
  721. cz13
  722. <p><strong class="examples_text">Example:</strong></p>
  723. <pre class="listing"><span class="Keyword">discard</span></pre>
  724. </dd>
  725. </div>
  726. </div>
  727. <div id="z17-procs-all">
  728. <div id="z17">
  729. <dt><pre><span class="Keyword">proc</span> <a href="#z17"><span class="Identifier">z17</span></a><span class="Other">(</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  730. <dd>
  731. cz17 rest
  732. <p><strong class="examples_text">Example:</strong></p>
  733. <pre class="listing"><span class="Keyword">discard</span> <span class="DecNumber">1</span></pre>rest
  734. </dd>
  735. </div>
  736. </div>
  737. </dl>
  738. </div>
  739. <div class="section" id="14">
  740. <h1><a class="toc-backref" href="#14">Methods</a></h1>
  741. <dl class="item">
  742. <div id="method1-methods-all">
  743. <div id="method1.e,Moo">
  744. <dt><pre><span class="Keyword">method</span> <a href="#method1.e%2CMoo"><span class="Identifier">method1</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <span class="Identifier">Moo</span><span class="Other">)</span> {.<span class="Identifier">base</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  745. <dd>
  746. foo1
  747. </dd>
  748. </div>
  749. </div>
  750. <div id="method2-methods-all">
  751. <div id="method2.e,Moo">
  752. <dt><pre><span class="Keyword">method</span> <a href="#method2.e%2CMoo"><span class="Identifier">method2</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <span class="Identifier">Moo</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">int</span> {.<span class="Identifier">base</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  753. <dd>
  754. foo2
  755. </dd>
  756. </div>
  757. </div>
  758. <div id="method3-methods-all">
  759. <div id="method3.e,Moo">
  760. <dt><pre><span class="Keyword">method</span> <a href="#method3.e%2CMoo"><span class="Identifier">method3</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <span class="Identifier">Moo</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">int</span> {.<span class="Identifier">base</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  761. <dd>
  762. foo3
  763. </dd>
  764. </div>
  765. </div>
  766. </dl>
  767. </div>
  768. <div class="section" id="15">
  769. <h1><a class="toc-backref" href="#15">Iterators</a></h1>
  770. <dl class="item">
  771. <div id="fromUtils1-iterators-all">
  772. <div id="fromUtils1.i">
  773. <dt><pre><span class="Keyword">iterator</span> <a href="#fromUtils1.i"><span class="Identifier">fromUtils1</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">int</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  774. <dd>
  775. <p><strong class="examples_text">Example:</strong></p>
  776. <pre class="listing"><span class="Comment"># ok1</span>
  777. <span class="Identifier">assert</span> <span class="DecNumber">1</span> <span class="Operator">==</span> <span class="DecNumber">1</span>
  778. <span class="Comment"># ok2</span></pre>
  779. </dd>
  780. </div>
  781. </div>
  782. <div id="iter1-iterators-all">
  783. <div id="iter1.i,int">
  784. <dt><pre><span class="Keyword">iterator</span> <a href="#iter1.i%2Cint"><span class="Identifier">iter1</span></a><span class="Other">(</span><span class="Identifier">n</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">int</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  785. <dd>
  786. foo1
  787. </dd>
  788. </div>
  789. </div>
  790. <div id="iter2-iterators-all">
  791. <div id="iter2.i,int">
  792. <dt><pre><span class="Keyword">iterator</span> <a href="#iter2.i%2Cint"><span class="Identifier">iter2</span></a><span class="Other">(</span><span class="Identifier">n</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">int</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  793. <dd>
  794. foo2
  795. <p><strong class="examples_text">Example:</strong></p>
  796. <pre class="listing"><span class="Keyword">discard</span> <span class="Comment"># bar</span></pre>
  797. </dd>
  798. </div>
  799. </div>
  800. </dl>
  801. </div>
  802. <div class="section" id="17">
  803. <h1><a class="toc-backref" href="#17">Macros</a></h1>
  804. <dl class="item">
  805. <div id="bar-macros-all">
  806. <div id="bar.m">
  807. <dt><pre><span class="Keyword">macro</span> <a href="#bar.m"><span class="Identifier">bar</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">untyped</span></pre></dt>
  808. <dd>
  809. </dd>
  810. </div>
  811. </div>
  812. <div id="z16-macros-all">
  813. <div id="z16.m">
  814. <dt><pre><span class="Keyword">macro</span> <a href="#z16.m"><span class="Identifier">z16</span></a><span class="Other">(</span><span class="Other">)</span></pre></dt>
  815. <dd>
  816. <p><strong class="examples_text">Example:</strong></p>
  817. <pre class="listing"><span class="Keyword">discard</span> <span class="DecNumber">1</span></pre>cz16 after
  818. <p><strong class="examples_text">Example:</strong></p>
  819. <pre class="listing"><span class="Identifier">doAssert</span> <span class="DecNumber">2</span> <span class="Operator">==</span> <span class="DecNumber">1</span> <span class="Operator">+</span> <span class="DecNumber">1</span></pre>
  820. </dd>
  821. </div>
  822. </div>
  823. <div id="z18-macros-all">
  824. <div id="z18.m">
  825. <dt><pre><span class="Keyword">macro</span> <a href="#z18.m"><span class="Identifier">z18</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">int</span></pre></dt>
  826. <dd>
  827. cz18
  828. </dd>
  829. </div>
  830. </div>
  831. </dl>
  832. </div>
  833. <div class="section" id="18">
  834. <h1><a class="toc-backref" href="#18">Templates</a></h1>
  835. <dl class="item">
  836. <div id="foo-templates-all">
  837. <div id="foo.t,SomeType,SomeType">
  838. <dt><pre><span class="Keyword">template</span> <a href="#foo.t%2CSomeType%2CSomeType"><span class="Identifier">foo</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">:</span> <a href="subdir/subdir_b/utils.html#SomeType"><span class="Identifier">SomeType</span></a><span class="Other">)</span></pre></dt>
  839. <dd>
  840. This does nothing
  841. </dd>
  842. </div>
  843. </div>
  844. <div id="fromUtils2-templates-all">
  845. <div id="fromUtils2.t">
  846. <dt><pre><span class="Keyword">template</span> <a href="#fromUtils2.t"><span class="Identifier">fromUtils2</span></a><span class="Other">(</span><span class="Other">)</span></pre></dt>
  847. <dd>
  848. ok3
  849. <p><strong class="examples_text">Example:</strong></p>
  850. <pre class="listing"><span class="Keyword">discard</span> <span class="LongStringLit">&quot;&quot;&quot;should be shown as examples for fromUtils2
  851. in module calling fromUtilsGen&quot;&quot;&quot;</span></pre>
  852. </dd>
  853. </div>
  854. </div>
  855. <div id="myfn-templates-all">
  856. <div id="myfn.t">
  857. <dt><pre><span class="Keyword">template</span> <a href="#myfn.t"><span class="Identifier">myfn</span></a><span class="Other">(</span><span class="Other">)</span></pre></dt>
  858. <dd>
  859. <p><strong class="examples_text">Example:</strong></p>
  860. <pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">strutils</span>
  861. <span class="Comment">## issue #8871 preserve formatting</span>
  862. <span class="Comment">## line doc comment</span>
  863. <span class="Comment"># bar</span>
  864. <span class="Identifier">doAssert</span> <span class="StringLit">&quot;'foo&quot;</span> <span class="Operator">==</span> <span class="StringLit">&quot;'foo&quot;</span>
  865. <span class="LongComment">##[
  866. foo
  867. bar
  868. ]##</span>
  869. <span class="Identifier">doAssert</span><span class="Punctuation">:</span> <span class="Keyword">not</span> <span class="StringLit">&quot;foo&quot;</span><span class="Operator">.</span><span class="Identifier">startsWith</span> <span class="StringLit">&quot;ba&quot;</span>
  870. <span class="Keyword">block</span><span class="Punctuation">:</span>
  871. <span class="Keyword">discard</span> <span class="HexNumber">0xff</span> <span class="Comment"># elu par cette crapule</span>
  872. <span class="Comment"># should be in</span></pre>should be still in
  873. </dd>
  874. </div>
  875. </div>
  876. <div id="testNimDocTrailingExample-templates-all">
  877. <div id="testNimDocTrailingExample.t">
  878. <dt><pre><span class="Keyword">template</span> <a href="#testNimDocTrailingExample.t"><span class="Identifier">testNimDocTrailingExample</span></a><span class="Other">(</span><span class="Other">)</span></pre></dt>
  879. <dd>
  880. <p><strong class="examples_text">Example:</strong></p>
  881. <pre class="listing"><span class="Keyword">discard</span> <span class="DecNumber">2</span></pre>
  882. </dd>
  883. </div>
  884. </div>
  885. <div id="z6t-templates-all">
  886. <div id="z6t.t">
  887. <dt><pre><span class="Keyword">template</span> <a href="#z6t.t"><span class="Identifier">z6t</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">int</span></pre></dt>
  888. <dd>
  889. cz6t
  890. </dd>
  891. </div>
  892. </div>
  893. <div id="z14-templates-all">
  894. <div id="z14.t">
  895. <dt><pre><span class="Keyword">template</span> <a href="#z14.t"><span class="Identifier">z14</span></a><span class="Other">(</span><span class="Other">)</span></pre></dt>
  896. <dd>
  897. cz14
  898. <p><strong class="examples_text">Example:</strong></p>
  899. <pre class="listing"><span class="Keyword">discard</span></pre>
  900. </dd>
  901. </div>
  902. </div>
  903. <div id="z15-templates-all">
  904. <div id="z15.t">
  905. <dt><pre><span class="Keyword">template</span> <a href="#z15.t"><span class="Identifier">z15</span></a><span class="Other">(</span><span class="Other">)</span></pre></dt>
  906. <dd>
  907. cz15
  908. <p><strong class="examples_text">Example:</strong></p>
  909. <pre class="listing"><span class="Keyword">discard</span></pre>
  910. <p><strong class="examples_text">Example:</strong></p>
  911. <pre class="listing"><span class="Keyword">discard</span> <span class="DecNumber">3</span></pre>
  912. <p><strong class="examples_text">Example:</strong></p>
  913. <pre class="listing"><span class="Keyword">discard</span> <span class="DecNumber">4</span></pre>ok5 ok5b
  914. <p><strong class="examples_text">Example:</strong></p>
  915. <pre class="listing"><span class="Identifier">assert</span> <span class="Identifier">true</span></pre>
  916. <p><strong class="examples_text">Example:</strong></p>
  917. <pre class="listing"><span class="Keyword">discard</span> <span class="DecNumber">1</span></pre>in or out?
  918. </dd>
  919. </div>
  920. </div>
  921. </dl>
  922. </div>
  923. </div>
  924. </div>
  925. <div class="twelve-columns footer">
  926. <span class="nim-sprite"></span>
  927. <br>
  928. <small style="color: var(--hint);">Made with Nim. Generated: 1970-01-02 03:46:40 UTC</small>
  929. </div>
  930. </div>
  931. </div>
  932. <!-- Google fonts -->
  933. <link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
  934. <link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
  935. </body>
  936. </html>