testproject.html 70 KB

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