Update documentation
This commit is contained in:
Ganesh Viswanathan
parent
3d52e60b8b
commit
edc1366f14
14 changed files with 139 additions and 1149 deletions
|
|
@ -805,13 +805,17 @@ function main() {
|
|||
<div class="document" id="documentId">
|
||||
<div class="container">
|
||||
<h1 class="title">Index</h1>
|
||||
Modules: <a href="build.html">build</a>, <a href="cimport.html">cimport</a>, <a href="compat.html">compat</a>, <a href="git.html">git</a>, <a href="paths.html">paths</a>, <a href="plugin.html">plugin</a>, <a href="types.html">types</a>.<br/><p /><h2>API symbols</h2>
|
||||
Modules: <a href="build.html">build</a>, <a href="cimport.html">cimport</a>, <a href="compat.html">compat</a>, <a href="paths.html">paths</a>, <a href="plugin.html">plugin</a>, <a href="types.html">types</a>.<br/><p /><h2>API symbols</h2>
|
||||
<dl><dt><a name="c2nImport" href="#c2nImport"><span>c2nImport:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="cimport: c2nImport(filename: static string; recurse: static bool = false;
|
||||
dynlib: static string = ""; mode: static string = "c"; flags: static string = ""): untyped" href="cimport.html#c2nImport.m%2C%2Cstring%2Cstring%2Cstring">cimport: c2nImport(filename: static string; recurse: static bool = false;
|
||||
dynlib: static string = ""; mode: static string = "c"; flags: static string = ""): untyped</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="cacheDir" href="#cacheDir"><span>cacheDir:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="paths: cacheDir" href="paths.html#cacheDir">paths: cacheDir</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="cAddSearchDir" href="#cAddSearchDir"><span>cAddSearchDir:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="cimport: cAddSearchDir(dir: string)" href="cimport.html#cAddSearchDir%2Cstring">cimport: cAddSearchDir(dir: string)</a></li>
|
||||
|
|
@ -853,14 +857,10 @@ function main() {
|
|||
<dt><a name="cmake" href="#cmake"><span>cmake:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="build: cmake(path, check, flags: string)" href="build.html#cmake%2Cstring%2Cstring%2Cstring">build: cmake(path, check, flags: string)</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="git: cmake(path, check, flags: string)" href="git.html#cmake%2Cstring%2Cstring%2Cstring">git: cmake(path, check, flags: string)</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="configure" href="#configure"><span>configure:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="build: configure(path, check: string; flags = "")" href="build.html#configure%2Cstring%2Cstring%2Cstring">build: configure(path, check: string; flags = "")</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="git: configure(path, check: string; flags = "")" href="git.html#configure%2Cstring%2Cstring%2Cstring">git: configure(path, check: string; flags = "")</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="cOverride" href="#cOverride"><span>cOverride:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
|
|
@ -869,8 +869,6 @@ function main() {
|
|||
<dt><a name="cpFile" href="#cpFile"><span>cpFile:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="build: cpFile(source, dest: string; move = false)" href="build.html#cpFile%2Cstring%2Cstring">build: cpFile(source, dest: string; move = false)</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="git: cpFile(source, dest: string; move = false)" href="git.html#cpFile%2Cstring%2Cstring">git: cpFile(source, dest: string; move = false)</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="cPlugin" href="#cPlugin"><span>cPlugin:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
|
|
@ -891,8 +889,6 @@ function main() {
|
|||
<dt><a name="downloadUrl" href="#downloadUrl"><span>downloadUrl:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="build: downloadUrl(url, outdir: string)" href="build.html#downloadUrl%2Cstring%2Cstring">build: downloadUrl(url, outdir: string)</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="git: downloadUrl(url, outdir: string)" href="git.html#downloadUrl%2Cstring%2Cstring">git: downloadUrl(url, outdir: string)</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="enumOp" href="#enumOp"><span>enumOp:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
|
|
@ -901,8 +897,6 @@ function main() {
|
|||
<dt><a name="execAction" href="#execAction"><span>execAction:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="build: execAction(cmd: string; retry = 0; nostderr = false): string" href="build.html#execAction%2Cstring%2Cint">build: execAction(cmd: string; retry = 0; nostderr = false): string</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="git: execAction(cmd: string; nostderr = false): string" href="git.html#execAction%2Cstring">git: execAction(cmd: string; nostderr = false): string</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="extractTar" href="#extractTar"><span>extractTar:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
|
|
@ -911,18 +905,14 @@ function main() {
|
|||
<dt><a name="extractZip" href="#extractZip"><span>extractZip:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="build: extractZip(zipfile, outdir: string)" href="build.html#extractZip%2Cstring%2Cstring">build: extractZip(zipfile, outdir: string)</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="git: extractZip(zipfile, outdir: string)" href="git.html#extractZip%2Cstring%2Cstring">git: extractZip(zipfile, outdir: string)</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="findExe" href="#findExe"><span>findExe:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="build: findExe(exe: string): string" href="build.html#findExe%2Cstring">build: findExe(exe: string): string</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="git: findExe(exe: string): string" href="git.html#findExe%2Cstring">git: findExe(exe: string): string</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="findFile" href="#findFile"><span>findFile:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="build: findFile(file: string | Regex; dir: string; recurse = true; first = false): string" href="build.html#findFile%2C%2Cstring">build: findFile(file: string | Regex; dir: string; recurse = true; first = false): string</a></li>
|
||||
data-doc-search-tag="build: findFile(file: string; dir: string; recurse = true; first = false; regex = false): string" href="build.html#findFile%2Cstring%2Cstring">build: findFile(file: string; dir: string; recurse = true; first = false; regex = false): string</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="flagBuild" href="#flagBuild"><span>flagBuild:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
|
|
@ -950,54 +940,46 @@ function main() {
|
|||
conFlags: static[string] = ""; cmakeFlags: static[string] = "";
|
||||
makeFlags: static[string] = ""; altNames: static[string] = ""): untyped</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="getProjectCacheDir" href="#getProjectCacheDir"><span>getProjectCacheDir:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="build: getProjectCacheDir(name: string; forceClean = true): string" href="build.html#getProjectCacheDir%2Cstring">build: getProjectCacheDir(name: string; forceClean = true): string</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="gitCheckout" href="#gitCheckout"><span>gitCheckout:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="build: gitCheckout(file, outdir: string)" href="build.html#gitCheckout%2Cstring%2Cstring">build: gitCheckout(file, outdir: string)</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="git: gitCheckout(file, outdir: string)" href="git.html#gitCheckout%2Cstring%2Cstring">git: gitCheckout(file, outdir: string)</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="gitPull" href="#gitPull"><span>gitPull:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="build: gitPull(url: string; outdir = ""; plist = ""; checkout = "")" href="build.html#gitPull%2Cstring%2Cstring%2Cstring%2Cstring">build: gitPull(url: string; outdir = ""; plist = ""; checkout = "")</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="git: gitPull(url: string; outdir = ""; plist = ""; checkout = "")" href="git.html#gitPull%2Cstring%2Cstring%2Cstring%2Cstring">git: gitPull(url: string; outdir = ""; plist = ""; checkout = "")</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="gitReset" href="#gitReset"><span>gitReset:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="build: gitReset(outdir: string)" href="build.html#gitReset%2Cstring">build: gitReset(outdir: string)</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="git: gitReset(outdir: string)" href="git.html#gitReset%2Cstring">git: gitReset(outdir: string)</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="incDir" href="#incDir"><span>incDir:</span></a></dt><dd><ul class="simple">
|
||||
<dt><a name="isDefined" href="#isDefined"><span>isDefined:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="paths: incDir(): string" href="paths.html#incDir">paths: incDir(): string</a></li>
|
||||
data-doc-search-tag="build: isDefined(def: untyped): untyped" href="build.html#isDefined.m%2Cuntyped">build: isDefined(def: untyped): untyped</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="linkLibs" href="#linkLibs"><span>linkLibs:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="build: linkLibs(names: openArray[string]; staticLink = true): string" href="build.html#linkLibs%2CopenArray%5Bstring%5D">build: linkLibs(names: openArray[string]; staticLink = true): string</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="make" href="#make"><span>make:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="build: make(path, check: string | Regex; flags = "")" href="build.html#make%2C%2C%2Cstring">build: make(path, check: string | Regex; flags = "")</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="git: make(path, check: string; flags = "")" href="git.html#make%2Cstring%2Cstring%2Cstring">git: make(path, check: string; flags = "")</a></li>
|
||||
data-doc-search-tag="build: make(path, check: string; flags = ""; regex = false)" href="build.html#make%2Cstring%2Cstring%2Cstring">build: make(path, check: string; flags = ""; regex = false)</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="mkDir" href="#mkDir"><span>mkDir:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="build: mkDir(dir: string)" href="build.html#mkDir%2Cstring">build: mkDir(dir: string)</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="git: mkDir(dir: string)" href="git.html#mkDir%2Cstring">git: mkDir(dir: string)</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="mvFile" href="#mvFile"><span>mvFile:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="build: mvFile(source, dest: string)" href="build.html#mvFile%2Cstring%2Cstring">build: mvFile(source, dest: string)</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="git: mvFile(source, dest: string)" href="git.html#mvFile%2Cstring%2Cstring">git: mvFile(source, dest: string)</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="myNormalizedPath" href="#myNormalizedPath"><span>myNormalizedPath:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="compat: myNormalizedPath(path: string): string" href="compat.html#myNormalizedPath%2Cstring">compat: myNormalizedPath(path: string): string</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="nimteropBuildDir" href="#nimteropBuildDir"><span>nimteropBuildDir:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="paths: nimteropBuildDir(): string" href="paths.html#nimteropBuildDir">paths: nimteropBuildDir(): string</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="nimteropRoot" href="#nimteropRoot"><span>nimteropRoot:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="paths: nimteropRoot(): string" href="paths.html#nimteropRoot">paths: nimteropRoot(): string</a></li>
|
||||
|
|
@ -1016,15 +998,11 @@ function main() {
|
|||
</ul></dd>
|
||||
<dt><a name="rmDir" href="#rmDir"><span>rmDir:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="build: rmDir(source: string)" href="build.html#rmDir%2Cstring">build: rmDir(source: string)</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="git: rmDir(source: string)" href="git.html#rmDir%2Cstring">git: rmDir(source: string)</a></li>
|
||||
data-doc-search-tag="build: rmDir(dir: string)" href="build.html#rmDir%2Cstring">build: rmDir(dir: string)</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="rmFile" href="#rmFile"><span>rmFile:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="build: rmFile(source: string; dir = false)" href="build.html#rmFile%2Cstring">build: rmFile(source: string; dir = false)</a></li>
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="git: rmFile(source: string; dir = false)" href="git.html#rmFile%2Cstring">git: rmFile(source: string; dir = false)</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="sanitizePath" href="#sanitizePath"><span>sanitizePath:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
|
|
@ -1058,6 +1036,10 @@ function main() {
|
|||
<li><a class="reference external"
|
||||
data-doc-search-tag="paths: testsIncludeDir(): string" href="paths.html#testsIncludeDir">paths: testsIncludeDir(): string</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="time64_t" href="#time64_t"><span>time64_t:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="types: time64_t" href="types.html#time64_t">types: time64_t</a></li>
|
||||
</ul></dd>
|
||||
<dt><a name="time_t" href="#time_t"><span>time_t:</span></a></dt><dd><ul class="simple">
|
||||
<li><a class="reference external"
|
||||
data-doc-search-tag="types: time_t" href="types.html#time_t">types: time_t</a></li>
|
||||
|
|
@ -1079,7 +1061,7 @@ function main() {
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small>Made with Nim. Generated: 2019-10-04 01:43:50 UTC</small>
|
||||
<small>Made with Nim. Generated: 2019-10-10 23:38:17 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue