diff options
Diffstat (limited to 'nimdoc')
| -rw-r--r-- | nimdoc/test_out_index_dot_html/expected/index.html | 2 | ||||
| -rw-r--r-- | nimdoc/testproject/expected/subdir/subdir_b/utils.html | 5 | ||||
| -rw-r--r-- | nimdoc/testproject/expected/testproject.html | 33 | ||||
| -rw-r--r-- | nimdoc/testproject/expected/theindex.html | 8 | ||||
| -rw-r--r-- | nimdoc/testproject/testproject.nim | 8 |
5 files changed, 56 insertions, 0 deletions
diff --git a/nimdoc/test_out_index_dot_html/expected/index.html b/nimdoc/test_out_index_dot_html/expected/index.html index 8ee7dfd22..1dbcdd51c 100644 --- a/nimdoc/test_out_index_dot_html/expected/index.html +++ b/nimdoc/test_out_index_dot_html/expected/index.html @@ -820,6 +820,7 @@ function main() { </div> <div class="nine columns" id="content"> <div id="tocRoot"></div> + <p class="module-desc"></p> <div class="section" id="12"> <h1><a class="toc-backref" href="#12">Procs</a></h1> @@ -827,6 +828,7 @@ function main() { <a id="foo"></a> <dt><pre><span class="Keyword">proc</span> <a href="#foo"><span class="Identifier">foo</span></a><span class="Other">(</span><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><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><span class="Other">.}</span></span></pre></dt> <dd> + I do foo </dd> diff --git a/nimdoc/testproject/expected/subdir/subdir_b/utils.html b/nimdoc/testproject/expected/subdir/subdir_b/utils.html index 4c9a4fb19..6f7a0c6e4 100644 --- a/nimdoc/testproject/expected/subdir/subdir_b/utils.html +++ b/nimdoc/testproject/expected/subdir/subdir_b/utils.html @@ -844,6 +844,7 @@ function main() { </div> <div class="nine columns" id="content"> <div id="tocRoot"></div> + <p class="module-desc"> <h1><a class="toc-backref" id="this-is-now-a-header" href="#this-is-now-a-header">This is now a header</a></h1> <h2><a class="toc-backref" id="this-is-now-a-header-next-header" href="#this-is-now-a-header-next-header">Next header</a></h2> @@ -866,6 +867,7 @@ function main() { <dd> + </dd> </dl></div> @@ -875,6 +877,7 @@ function main() { <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">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><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><span class="Other">.}</span></span></pre></dt> <dd> + constructor. </dd> @@ -888,12 +891,14 @@ constructor. <dd> + </dd> <a id="bEnum.t"></a> <dt><pre><span class="Keyword">template</span> <a href="#bEnum.t"><span class="Identifier">bEnum</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">untyped</span></pre></dt> <dd> + </dd> </dl></div> diff --git a/nimdoc/testproject/expected/testproject.html b/nimdoc/testproject/expected/testproject.html index 504b64a69..1b2458a9b 100644 --- a/nimdoc/testproject/expected/testproject.html +++ b/nimdoc/testproject/expected/testproject.html @@ -837,6 +837,10 @@ function main() { <ul class="simple simple-toc-section"> <li><a class="reference" href="#bar%2CT%2CT" title="bar[T](a, b: T): T"><wbr />bar<span class="attachedType"></span></a></li> + <li><a class="reference" href="#baz%2CT%2CT" + title="baz[T](a, b: T): T"><wbr />baz<span class="attachedType"></span></a></li> + <li><a class="reference" href="#buzz%2CT%2CT" + title="buzz[T](a, b: T): T"><wbr />buzz<span class="attachedType"></span></a></li> <li><a class="reference" href="#isValid%2CT" title="isValid[T](x: T): bool"><wbr />is<wbr />Valid<span class="attachedType"></span></a></li> @@ -872,6 +876,7 @@ function main() { </div> <div class="nine columns" id="content"> <div id="tocRoot"></div> + <p class="module-desc">This is the top level module. <p><strong class="examples_text">Examples:</strong></p> <pre class="listing"><span class="Keyword">import</span> @@ -893,6 +898,7 @@ function main() { <dt><pre><a href="testproject.html#A"><span class="Identifier">A</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">inject</span></span><span class="Other">.}</span></span> <span class="Other">=</span> <span class="Keyword">enum</span> <span class="Identifier">aA</span></pre></dt> <dd> + The enum A. </dd> @@ -900,6 +906,7 @@ The enum A. <dt><pre><a href="testproject.html#B"><span class="Identifier">B</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">inject</span></span><span class="Other">.}</span></span> <span class="Other">=</span> <span class="Keyword">enum</span> <span class="Identifier">bB</span></pre></dt> <dd> + The enum B. </dd> @@ -913,6 +920,7 @@ The enum B. <dd> + </dd> </dl></div> @@ -924,12 +932,34 @@ The enum B. <dd> + +</dd> +<a id="baz,T,T"></a> +<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">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">deprecated</span></span><span class="Other">.}</span></span></pre></dt> +<dd> + <div class="deprecation-message"> + <b>Deprecated</b> + </div> + +This is deprecated without message. + +</dd> +<a id="buzz,T,T"></a> +<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">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">deprecated</span><span class="Other">:</span> <span class="StringLit">"since v0.20"</span></span><span class="Other">.}</span></span></pre></dt> +<dd> + <div class="deprecation-message"> + <b>Deprecated:</b> since v0.20 + </div> + +This is deprecated with a message. + </dd> <a id="isValid,T"></a> <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> <dd> + </dd> </dl></div> @@ -939,6 +969,7 @@ The enum B. <a id="someFunc"></a> <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">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><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><span class="Other">.}</span></span></pre></dt> <dd> + My someFunc. Stuff in <tt class="docutils literal"><span class="pre">quotes</span></tt> here. <a class="reference external" href="https://nim-lang.org">Some link</a> </dd> @@ -952,6 +983,7 @@ My someFunc. Stuff in <tt class="docutils literal"><span class="pre">quotes</spa <dd> + </dd> </dl></div> @@ -961,6 +993,7 @@ My someFunc. Stuff in <tt class="docutils literal"><span class="pre">quotes</spa <a id="foo.t,SomeType,SomeType"></a> <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> <dd> + This does nothing </dd> diff --git a/nimdoc/testproject/expected/theindex.html b/nimdoc/testproject/expected/theindex.html index de581bd41..58cab3ef3 100644 --- a/nimdoc/testproject/expected/theindex.html +++ b/nimdoc/testproject/expected/theindex.html @@ -811,10 +811,18 @@ function main() { <li><a class="reference external" data-doc-search-tag="testproject: bar(): untyped" href="testproject.html#bar.m">testproject: bar(): untyped</a></li> </ul></dd> +<dt><a name="baz" href="#baz"><span>baz:</span></a></dt><dd><ul class="simple"> +<li><a class="reference external" + data-doc-search-tag="testproject: baz[T](a, b: T): T" href="testproject.html#baz%2CT%2CT">testproject: baz[T](a, b: T): T</a></li> + </ul></dd> <dt><a name="bEnum" href="#bEnum"><span>bEnum:</span></a></dt><dd><ul class="simple"> <li><a class="reference external" data-doc-search-tag="utils: bEnum(): untyped" href="subdir/subdir_b/utils.html#bEnum.t">utils: bEnum(): untyped</a></li> </ul></dd> +<dt><a name="buzz" href="#buzz"><span>buzz:</span></a></dt><dd><ul class="simple"> +<li><a class="reference external" + data-doc-search-tag="testproject: buzz[T](a, b: T): T" href="testproject.html#buzz%2CT%2CT">testproject: buzz[T](a, b: T): T</a></li> + </ul></dd> <dt><a name="enumValueA" href="#enumValueA"><span>enumValueA:</span></a></dt><dd><ul class="simple"> <li><a class="reference external" data-doc-search-tag="SomeType.enumValueA" href="subdir/subdir_b/utils.html#enumValueA">SomeType.enumValueA</a></li> diff --git a/nimdoc/testproject/testproject.nim b/nimdoc/testproject/testproject.nim index 32bf286e8..c3ab6a153 100644 --- a/nimdoc/testproject/testproject.nim +++ b/nimdoc/testproject/testproject.nim @@ -18,6 +18,14 @@ template foo*(a, b: SomeType) = proc bar*[T](a, b: T): T = result = a + b +proc baz*[T](a, b: T): T {.deprecated.} = + ## This is deprecated without message. + result = a + b + +proc buzz*[T](a, b: T): T {.deprecated: "since v0.20".} = + ## This is deprecated with a message. + result = a + b + import std/macros macro bar*(): untyped = |