support same-line doc comments in routines (#18595)

* support same-line comments in routines * remove assert as per review comment
2021-07-27 10:50:59 -07:00 · 2021-07-27 10:50:59 -07:00 · 8d2f6bba3a
commit 8d2f6bba3a
parent 4920b06973
6 changed files with 205 additions and 1 deletions
--- a/nimdoc/testproject/expected/subdir/subdir_b/utils.html
+++ b/nimdoc/testproject/expected/subdir/subdir_b/utils.html
@ -115,7 +115,52 @@ window.addEventListener('DOMContentLoaded', main);
 <li>
  <a class="reference reference-toplevel" href="#12" id="62">Procs</a>
  <ul class="simple simple-toc-section">
-      <ul class="simple nested-toc-section">someType
+      <ul class="simple nested-toc-section">fn2
+      <li><a class="reference" href="#fn2"
+    title="fn2()">fn2()</a></li>
+
+  </ul>
+  <ul class="simple nested-toc-section">fn3
+      <li><a class="reference" href="#fn3"
+    title="fn3(): auto">fn3(): auto</a></li>
+
+  </ul>
+  <ul class="simple nested-toc-section">fn4
+      <li><a class="reference" href="#fn4"
+    title="fn4(): auto">fn4(): auto</a></li>
+
+  </ul>
+  <ul class="simple nested-toc-section">fn5
+      <li><a class="reference" href="#fn5"
+    title="fn5()">fn5()</a></li>
+
+  </ul>
+  <ul class="simple nested-toc-section">fn6
+      <li><a class="reference" href="#fn6"
+    title="fn6()">fn6()</a></li>
+
+  </ul>
+  <ul class="simple nested-toc-section">fn7
+      <li><a class="reference" href="#fn7"
+    title="fn7()">fn7()</a></li>
+
+  </ul>
+  <ul class="simple nested-toc-section">fn8
+      <li><a class="reference" href="#fn8"
+    title="fn8(): auto">fn8(): auto</a></li>
+
+  </ul>
+  <ul class="simple nested-toc-section">fn9
+      <li><a class="reference" href="#fn9%2Cint"
+    title="fn9(a: int): int">fn9(a: int): int</a></li>
+
+  </ul>
+  <ul class="simple nested-toc-section">fn10
+      <li><a class="reference" href="#fn10%2Cint"
+    title="fn10(a: int): int">fn10(a: int): int</a></li>
+
+  </ul>
+  <ul class="simple nested-toc-section">someType
      <li><a class="reference" href="#someType_2"
    title="someType(): SomeType">someType(): SomeType</a></li>

@ -181,6 +226,69 @@ window.addEventListener('DOMContentLoaded', main);
 <div class="section" id="12">
 <h1><a class="toc-backref" href="#12">Procs</a></h1>
 <dl class="item">
+<a id="fn2"></a>
+<dt><pre><span class="Keyword">proc</span> <a href="#fn2"><span class="Identifier">fn2</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>.}</pre></dt>
+<dd>
+
+comment
+
+</dd>
+<a id="fn3"></a>
+<dt><pre><span class="Keyword">proc</span> <a href="#fn3"><span class="Identifier">fn3</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">auto</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>.}</pre></dt>
+<dd>
+
+comment
+
+</dd>
+<a id="fn4"></a>
+<dt><pre><span class="Keyword">proc</span> <a href="#fn4"><span class="Identifier">fn4</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">auto</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>.}</pre></dt>
+<dd>
+
+comment
+
+</dd>
+<a id="fn5"></a>
+<dt><pre><span class="Keyword">proc</span> <a href="#fn5"><span class="Identifier">fn5</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>.}</pre></dt>
+<dd>
+
+comment
+
+</dd>
+<a id="fn6"></a>
+<dt><pre><span class="Keyword">proc</span> <a href="#fn6"><span class="Identifier">fn6</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>.}</pre></dt>
+<dd>
+
+comment
+
+</dd>
+<a id="fn7"></a>
+<dt><pre><span class="Keyword">proc</span> <a href="#fn7"><span class="Identifier">fn7</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>.}</pre></dt>
+<dd>
+
+comment
+
+</dd>
+<a id="fn8"></a>
+<dt><pre><span class="Keyword">proc</span> <a href="#fn8"><span class="Identifier">fn8</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">auto</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>.}</pre></dt>
+<dd>
+
+comment
+
+</dd>
+<a id="fn9,int"></a>
+<dt><pre><span class="Keyword">func</span> <a href="#fn9%2Cint"><span class="Identifier">fn9</span></a><span class="Other">(</span><span class="Identifier">a</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>.}</pre></dt>
+<dd>
+
+comment
+
+</dd>
+<a id="fn10,int"></a>
+<dt><pre><span class="Keyword">func</span> <a href="#fn10%2Cint"><span class="Identifier">fn10</span></a><span class="Other">(</span><span class="Identifier">a</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>.}</pre></dt>
+<dd>
+
+comment
+
+</dd>
 <a id="someType_2"></a>
 <dt><pre><span class="Keyword">proc</span> <a href="#someType_2"><span class="Identifier">someType</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="utils.html#SomeType"><span class="Identifier">SomeType</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>.}</pre></dt>
 <dd>