Update documentation

This commit is contained in:
Ganesh Viswanathan 2019-10-10 18:38:17 -05:00
commit edc1366f14
14 changed files with 139 additions and 1149 deletions

View file

@ -823,19 +823,29 @@ function main() {
</select>
</div>
<ul class="simple simple-toc" id="toc-list">
<li>
<a class="reference reference-toplevel" href="#6" id="56">Imports</a>
<ul class="simple simple-toc-section">
</ul>
</li>
<li>
<a class="reference reference-toplevel" href="#10" id="60">Consts</a>
<ul class="simple simple-toc-section">
<li><a class="reference" href="#cacheDir"
title="cacheDir = &quot;/home/genotrance/.cache/nim/nimterop/nimterop&quot;"><wbr />cache<wbr />Dir<span class="attachedType"></span></a></li>
</ul>
</li>
<li>
<a class="reference reference-toplevel" href="#12" id="62">Procs</a>
<ul class="simple simple-toc-section">
<li><a class="reference" href="#nimteropRoot"
title="nimteropRoot(): string"><wbr />nimterop<wbr />Root<span class="attachedType"></span></a></li>
<li><a class="reference" href="#nimteropBuildDir"
title="nimteropBuildDir(): string"><wbr />nimterop<wbr />Build<wbr />Dir<span class="attachedType"></span></a></li>
<li><a class="reference" href="#nimteropSrcDir"
title="nimteropSrcDir(): string"><wbr />nimterop<wbr />Src<wbr />Dir<span class="attachedType"></span></a></li>
<li><a class="reference" href="#toastExePath"
title="toastExePath(): string"><wbr />toast<wbr />Exe<wbr />Path<span class="attachedType"></span></a></li>
<li><a class="reference" href="#incDir"
title="incDir(): string"><wbr />inc<wbr />Dir<span class="attachedType"></span></a></li>
<li><a class="reference" href="#testsIncludeDir"
title="testsIncludeDir(): string"><wbr />tests<wbr />Include<wbr />Dir<span class="attachedType"></span></a></li>
@ -849,7 +859,24 @@ function main() {
<div id="tocRoot"></div>
<p class="module-desc"></p>
<div class="section" id="12">
<div class="section" id="6">
<h1><a class="toc-backref" href="#6">Imports</a></h1>
<dl class="item">
<a class="reference external" href="build.html">build</a>
</dl></div>
<div class="section" id="10">
<h1><a class="toc-backref" href="#10">Consts</a></h1>
<dl class="item">
<a id="cacheDir"></a>
<dt><pre><a href="paths.html#cacheDir"><span class="Identifier">cacheDir</span></a> <span class="Other">=</span> <span class="StringLit">&quot;/home/genotrance/.cache/nim/nimterop/nimterop&quot;</span></pre></dt>
<dd>
</dd>
</dl></div>
<div class="section" id="12">
<h1><a class="toc-backref" href="#12">Procs</a></h1>
<dl class="item">
<a id="nimteropRoot"></a>
@ -858,13 +885,6 @@ function main() {
</dd>
<a id="nimteropBuildDir"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#nimteropBuildDir"><span class="Identifier">nimteropBuildDir</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">string</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>
all nimterop generated files go under here (gitignored)
</dd>
<a id="nimteropSrcDir"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#nimteropSrcDir"><span class="Identifier">nimteropSrcDir</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">string</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>
@ -879,13 +899,6 @@ all nimterop generated files go under here (gitignored)
</dd>
<a id="incDir"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#incDir"><span class="Identifier">incDir</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">string</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>
</dd>
<a id="testsIncludeDir"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#testsIncludeDir"><span class="Identifier">testsIncludeDir</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">string</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>
@ -904,7 +917,7 @@ all nimterop generated files go under here (gitignored)
<div class="twelve-columns footer">
<span class="nim-sprite"></span>
<br/>
<small>Made with Nim. Generated: 2019-10-04 01:43:48 UTC</small>
<small>Made with Nim. Generated: 2019-10-10 23:38:15 UTC</small>
</div>
</div>
</div>