Update documentation

This commit is contained in:
Ganesh Viswanathan 2019-01-31 09:20:56 -06:00
commit 240f745dce
8 changed files with 1412 additions and 47 deletions

View file

@ -1296,12 +1296,12 @@ function main() {
<div class="section" id="5">
<h1><a class="toc-backref" href="#5">Exports</a></h1>
<dl class="item">
<a href="types.html#va_list"><span class="Identifier">va_list</span></a>, <a class="reference external" href="types.html">types</a>, <a href="types.html#time_t"><span class="Identifier">time_t</span></a>, <a href="types.html#ptrdiff_t"><span class="Identifier">ptrdiff_t</span></a>
<a href="types.html#time_t"><span class="Identifier">time_t</span></a>, <a href="types.html#defineEnum"><span class="Identifier">defineEnum</span></a>, <a href="types.html#va_list"><span class="Identifier">va_list</span></a>, <a class="reference external" href="types.html">types</a>, <a href="types.html#enumOp"><span class="Identifier">enumOp</span></a>, <a href="types.html#ptrdiff_t"><span class="Identifier">ptrdiff_t</span></a>
</dl></div>
<div class="section" id="6">
<h1><a class="toc-backref" href="#6">Imports</a></h1>
<dl class="item">
<a class="reference external" href="plugin.html">plugin</a>, <a class="reference external" href="types.html">types</a>
<a class="reference external" href="plugin.html">plugin</a>, <a class="reference external" href="types.html">types</a>, <a class="reference external" href="paths.html">paths</a>
</dl></div>
<div class="section" id="12">
<h1><a class="toc-backref" href="#12">Procs</a></h1>
@ -1440,7 +1440,7 @@ Add an include directory that is forwarded to the C/C++ compiler using <tt class
<div class="twelve-columns footer">
<span class="nim-sprite"></span>
<br/>
<small>Made with Nim. Generated: 2019-01-28 16:57:12 UTC</small>
<small>Made with Nim. Generated: 2019-01-31 15:20:53 UTC</small>
</div>
</div>
</div>

View file

@ -1238,27 +1238,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="#12" id="62">Procs</a>
<ul class="simple simple-toc-section">
<li><a class="reference" href="#execAction%2Cstring"
title="execAction(cmd: string; nostderr = false): string"><wbr />exec<wbr />Action<span class="attachedType" style="visibility:hidden"></span></a></li>
</ul>
</li>
<li>
<a class="reference reference-toplevel" href="#17" id="67">Macros</a>
<ul class="simple simple-toc-section">
<li><a class="reference" href="#extractZip.m%2C%2C"
title="extractZip(zipfile, outdir: static string): untyped"><wbr />extract<wbr />Zip<span class="attachedType" style="visibility:hidden"></span></a></li>
<li><a class="reference" href="#downloadUrl.m%2C%2C"
title="downloadUrl(url, outdir: static string): untyped"><wbr />download<wbr />Url<span class="attachedType" style="visibility:hidden"></span></a></li>
<li><a class="reference" href="#gitReset.m%2C"
title="gitReset(outdir: static string): untyped"><wbr />git<wbr />Reset<span class="attachedType" style="visibility:hidden"></span></a></li>
<li><a class="reference" href="#gitCheckout.m%2C%2C"
title="gitCheckout(file, outdir: static string): untyped"><wbr />git<wbr />Checkout<span class="attachedType" style="visibility:hidden"></span></a></li>
<li><a class="reference" href="#gitPull.m%2C%2Cstring%2Cstring%2Cstring"
title="gitPull(url: static string; outdirN = &quot;&quot;; plistN = &quot;&quot;; checkoutN = &quot;&quot;): untyped"><wbr />git<wbr />Pull<span class="attachedType" style="visibility:hidden"></span></a></li>
<li><a class="reference" href="#extractZip%2Cstring%2Cstring"
title="extractZip(zipfile, outdir: string)"><wbr />extract<wbr />Zip<span class="attachedType" style="visibility:hidden"></span></a></li>
<li><a class="reference" href="#downloadUrl%2Cstring%2Cstring"
title="downloadUrl(url, outdir: string)"><wbr />download<wbr />Url<span class="attachedType" style="visibility:hidden"></span></a></li>
<li><a class="reference" href="#gitReset%2Cstring"
title="gitReset(outdir: string)"><wbr />git<wbr />Reset<span class="attachedType" style="visibility:hidden"></span></a></li>
<li><a class="reference" href="#relativePathNaive%2Cstring%2Cstring"
title="relativePathNaive(file, base: string): string"><wbr />relative<wbr />Path<wbr />Naive<span class="attachedType" style="visibility:hidden"></span></a></li>
<li><a class="reference" href="#gitCheckout%2Cstring%2Cstring"
title="gitCheckout(file, outdir: string)"><wbr />git<wbr />Checkout<span class="attachedType" style="visibility:hidden"></span></a></li>
<li><a class="reference" href="#gitPull%2Cstring%2Cstring%2Cstring%2Cstring"
title="gitPull(url: string; outdir = &quot;&quot;; plist = &quot;&quot;; checkout = &quot;&quot;)"><wbr />git<wbr />Pull<span class="attachedType" style="visibility:hidden"></span></a></li>
</ul>
</li>
@ -1269,7 +1271,12 @@ function main() {
<div class="nine columns" id="content">
<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="paths.html">paths</a>
</dl></div>
<div class="section" id="12">
<h1><a class="toc-backref" href="#12">Procs</a></h1>
<dl class="item">
<a id="execAction,string"></a>
@ -1279,37 +1286,46 @@ function main() {
</dd>
</dl></div>
<div class="section" id="17">
<h1><a class="toc-backref" href="#17">Macros</a></h1>
<dl class="item">
<a id="extractZip.m,,"></a>
<dt><pre><span class="Keyword">macro</span> <span class="Identifier">extractZip</span><span class="Other">(</span><span class="Identifier">zipfile</span><span class="Other">,</span> <span class="Identifier">outdir</span><span class="Other">:</span> <span class="Identifier">static</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">untyped</span></pre></dt>
<a id="extractZip,string,string"></a>
<dt><pre><span class="Keyword">proc</span> <span class="Identifier">extractZip</span><span class="Other">(</span><span class="Identifier">zipfile</span><span class="Other">,</span> <span class="Identifier">outdir</span><span class="Other">:</span> <span class="Identifier">string</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="Identifier">OSError</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> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span>
<span class="Identifier">ExecIOEffect</span><span class="Other">,</span> <span class="Identifier">ReadIOEffect</span><span class="Other">,</span> <span class="Identifier">RootEffect</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
<dd>
</dd>
<a id="downloadUrl.m,,"></a>
<dt><pre><span class="Keyword">macro</span> <span class="Identifier">downloadUrl</span><span class="Other">(</span><span class="Identifier">url</span><span class="Other">,</span> <span class="Identifier">outdir</span><span class="Other">:</span> <span class="Identifier">static</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">untyped</span></pre></dt>
<a id="downloadUrl,string,string"></a>
<dt><pre><span class="Keyword">proc</span> <span class="Identifier">downloadUrl</span><span class="Other">(</span><span class="Identifier">url</span><span class="Other">,</span> <span class="Identifier">outdir</span><span class="Other">:</span> <span class="Identifier">string</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="Identifier">OSError</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> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span>
<span class="Identifier">ReadDirEffect</span><span class="Other">,</span> <span class="Identifier">ExecIOEffect</span><span class="Other">,</span> <span class="Identifier">ReadIOEffect</span><span class="Other">,</span> <span class="Identifier">RootEffect</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
<dd>
</dd>
<a id="gitReset.m,"></a>
<dt><pre><span class="Keyword">macro</span> <span class="Identifier">gitReset</span><span class="Other">(</span><span class="Identifier">outdir</span><span class="Other">:</span> <span class="Identifier">static</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">untyped</span></pre></dt>
<a id="gitReset,string"></a>
<dt><pre><span class="Keyword">proc</span> <span class="Identifier">gitReset</span><span class="Other">(</span><span class="Identifier">outdir</span><span class="Other">:</span> <span class="Identifier">string</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="Identifier">OSError</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">ExecIOEffect</span><span class="Other">,</span>
<span class="Identifier">ReadIOEffect</span><span class="Other">,</span> <span class="Identifier">RootEffect</span><span class="Other">,</span> <span class="Identifier">TimeEffect</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
<dd>
</dd>
<a id="gitCheckout.m,,"></a>
<dt><pre><span class="Keyword">macro</span> <span class="Identifier">gitCheckout</span><span class="Other">(</span><span class="Identifier">file</span><span class="Other">,</span> <span class="Identifier">outdir</span><span class="Other">:</span> <span class="Identifier">static</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">untyped</span></pre></dt>
<a id="relativePathNaive,string,string"></a>
<dt><pre><span class="Keyword">proc</span> <span class="Identifier">relativePathNaive</span><span class="Other">(</span><span class="Identifier">file</span><span class="Other">,</span> <span class="Identifier">base</span><span class="Other">:</span> <span class="Identifier">string</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>
naive version of <cite>os.relativePath</cite> ; remove after nim &gt;= 0.19.9
<p><strong class="examples_text">Examples:</strong></p>
<pre class="listing"><span class="Identifier">doAssert</span> <span class="StringLit">&quot;/foo/bar/baz/log.txt&quot;</span><span class="Other">.</span><span class="Identifier">relativePathNaive</span><span class="Other">(</span><span class="StringLit">&quot;/foo/bar&quot;</span><span class="Other">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;baz/log.txt&quot;</span></pre>
</dd>
<a id="gitCheckout,string,string"></a>
<dt><pre><span class="Keyword">proc</span> <span class="Identifier">gitCheckout</span><span class="Other">(</span><span class="Identifier">file</span><span class="Other">,</span> <span class="Identifier">outdir</span><span class="Other">:</span> <span class="Identifier">string</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="Identifier">OSError</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">ExecIOEffect</span><span class="Other">,</span> <span class="Identifier">ReadIOEffect</span><span class="Other">,</span> <span class="Identifier">RootEffect</span><span class="Other">,</span> <span class="Identifier">TimeEffect</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
<dd>
</dd>
<a id="gitPull.m,,string,string,string"></a>
<dt><pre><span class="Keyword">macro</span> <span class="Identifier">gitPull</span><span class="Other">(</span><span class="Identifier">url</span><span class="Other">:</span> <span class="Identifier">static</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">outdirN</span> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span><span class="Other">;</span> <span class="Identifier">plistN</span> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span><span class="Other">;</span> <span class="Identifier">checkoutN</span> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">untyped</span></pre></dt>
<a id="gitPull,string,string,string,string"></a>
<dt><pre><span class="Keyword">proc</span> <span class="Identifier">gitPull</span><span class="Other">(</span><span class="Identifier">url</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">outdir</span> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span><span class="Other">;</span> <span class="Identifier">plist</span> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span><span class="Other">;</span> <span class="Identifier">checkout</span> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</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="Identifier">OSError</span><span class="Other">,</span> <span class="Identifier">Exception</span><span class="Other">,</span> <span class="Identifier">IOError</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">ReadDirEffect</span><span class="Other">,</span> <span class="Identifier">ExecIOEffect</span><span class="Other">,</span>
<span class="Identifier">ReadIOEffect</span><span class="Other">,</span> <span class="Identifier">RootEffect</span><span class="Other">,</span> <span class="Identifier">TimeEffect</span><span class="Other">,</span> <span class="Identifier">WriteIOEffect</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
<dd>
@ -1324,7 +1340,7 @@ function main() {
<div class="twelve-columns footer">
<span class="nim-sprite"></span>
<br/>
<small>Made with Nim. Generated: 2019-01-28 16:53:07 UTC</small>
<small>Made with Nim. Generated: 2019-01-31 15:20:56 UTC</small>
</div>
</div>
</div>

11
git.idx
View file

@ -1,6 +1,7 @@
execAction git.html#execAction,string git: execAction(cmd: string; nostderr = false): string
extractZip git.html#extractZip.m,, git: extractZip(zipfile, outdir: static string): untyped
downloadUrl git.html#downloadUrl.m,, git: downloadUrl(url, outdir: static string): untyped
gitReset git.html#gitReset.m, git: gitReset(outdir: static string): untyped
gitCheckout git.html#gitCheckout.m,, git: gitCheckout(file, outdir: static string): untyped
gitPull git.html#gitPull.m,,string,string,string git: gitPull(url: static string; outdirN = &quot;&quot;; plistN = &quot;&quot;; checkoutN = &quot;&quot;): untyped
extractZip git.html#extractZip,string,string git: extractZip(zipfile, outdir: string)
downloadUrl git.html#downloadUrl,string,string git: downloadUrl(url, outdir: string)
gitReset git.html#gitReset,string git: gitReset(outdir: string)
relativePathNaive git.html#relativePathNaive,string,string git: relativePathNaive(file, base: string): string
gitCheckout git.html#gitCheckout,string,string git: gitCheckout(file, outdir: string)
gitPull git.html#gitPull,string,string,string,string git: gitPull(url: string; outdir = &quot;&quot;; plist = &quot;&quot;; checkout = &quot;&quot;)

1314
paths.html Normal file

File diff suppressed because it is too large Load diff

5
paths.idx Normal file
View file

@ -0,0 +1,5 @@
nimteropRoot paths.html#nimteropRoot, paths: nimteropRoot(): string
nimteropBuildDir paths.html#nimteropBuildDir, paths: nimteropBuildDir(): string
nimteropSrcDir paths.html#nimteropSrcDir, paths: nimteropSrcDir(): string
toastExePath paths.html#toastExePath, paths: toastExePath(): string
incDir paths.html#incDir, paths: incDir(): string

View file

@ -1287,7 +1287,7 @@ function main() {
<div class="twelve-columns footer">
<span class="nim-sprite"></span>
<br/>
<small>Made with Nim. Generated: 2019-01-28 16:57:08 UTC</small>
<small>Made with Nim. Generated: 2019-01-31 15:20:56 UTC</small>
</div>
</div>
</div>

View file

@ -1242,11 +1242,21 @@ function main() {
<a class="reference reference-toplevel" href="#7" id="57">Types</a>
<ul class="simple simple-toc-section">
<li><a class="reference" href="#time_t"
title="time_t = int32"><wbr />time_<wbr />t<span class="attachedType" style="visibility:hidden"></span></a></li>
title="time_t = Time"><wbr />time_<wbr />t<span class="attachedType" style="visibility:hidden"></span></a></li>
<li><a class="reference" href="#ptrdiff_t"
title="ptrdiff_t = ByteAddress"><wbr />ptrdiff_<wbr />t<span class="attachedType" style="visibility:hidden"></span></a></li>
<li><a class="reference" href="#va_list"
title="va_list {.importc: &quot;va_list&quot;, header: &quot;&lt;stdarg.h&gt;&quot;.} = object"><wbr />va_<wbr />list<span class="attachedType" style="visibility:hidden"></span></a></li>
title="va_list {.importc, header: &quot;&lt;stdarg.h&gt;&quot;.} = object"><wbr />va_<wbr />list<span class="attachedType" style="visibility:hidden"></span></a></li>
</ul>
</li>
<li>
<a class="reference reference-toplevel" href="#18" id="68">Templates</a>
<ul class="simple simple-toc-section">
<li><a class="reference" href="#enumOp.t%2C%2C%2C"
title="enumOp(op, typ, typout)"><wbr />enum<wbr />Op<span class="attachedType" style="visibility:hidden"></span></a></li>
<li><a class="reference" href="#defineEnum.t%2C"
title="defineEnum(typ)"><wbr />define<wbr />Enum<span class="attachedType" style="visibility:hidden"></span></a></li>
</ul>
</li>
@ -1261,7 +1271,7 @@ function main() {
<h1><a class="toc-backref" href="#7">Types</a></h1>
<dl class="item">
<a id="time_t"></a>
<dt><pre><a href="types.html#time_t"><span class="Identifier">time_t</span></a> <span class="Other">=</span> <span class="Identifier">int32</span></pre></dt>
<dt><pre><a href="types.html#time_t"><span class="Identifier">time_t</span></a> <span class="Other">=</span> <span class="Identifier">Time</span></pre></dt>
<dd>
@ -1273,7 +1283,24 @@ function main() {
</dd>
<a id="va_list"></a>
<dt><pre><a href="types.html#va_list"><span class="Identifier">va_list</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">importc</span><span class="Other">:</span> <span class="StringLit">&quot;va_list&quot;</span><span class="Other">,</span> <span class="Identifier">header</span><span class="Other">:</span> <span class="StringLit">&quot;&lt;stdarg.h&gt;&quot;</span></span><span class="Other">.}</span></span> <span class="Other">=</span> <span class="Keyword">object</span></pre></dt>
<dt><pre><a href="types.html#va_list"><span class="Identifier">va_list</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">importc</span><span class="Other">,</span> <span class="Identifier">header</span><span class="Other">:</span> <span class="StringLit">&quot;&lt;stdarg.h&gt;&quot;</span></span><span class="Other">.}</span></span> <span class="Other">=</span> <span class="Keyword">object</span></pre></dt>
<dd>
</dd>
</dl></div>
<div class="section" id="18">
<h1><a class="toc-backref" href="#18">Templates</a></h1>
<dl class="item">
<a id="enumOp.t,,,"></a>
<dt><pre><span class="Keyword">template</span> <span class="Identifier">enumOp</span><span class="Other">(</span><span class="Identifier">op</span><span class="Other">,</span> <span class="Identifier">typ</span><span class="Other">,</span> <span class="Identifier">typout</span><span class="Other">)</span></pre></dt>
<dd>
</dd>
<a id="defineEnum.t,"></a>
<dt><pre><span class="Keyword">template</span> <span class="Identifier">defineEnum</span><span class="Other">(</span><span class="Identifier">typ</span><span class="Other">)</span></pre></dt>
<dd>
@ -1288,7 +1315,7 @@ function main() {
<div class="twelve-columns footer">
<span class="nim-sprite"></span>
<br/>
<small>Made with Nim. Generated: 2019-01-28 16:57:08 UTC</small>
<small>Made with Nim. Generated: 2019-01-31 15:20:50 UTC</small>
</div>
</div>
</div>

View file

@ -1,3 +1,5 @@
time_t types.html#time_t types: time_t
ptrdiff_t types.html#ptrdiff_t types: ptrdiff_t
va_list types.html#va_list types: va_list
enumOp types.html#enumOp.t,,, types: enumOp(op, typ, typout)
defineEnum types.html#defineEnum.t, types: defineEnum(typ)