Update master documentation for changeset 72dd992e66
This commit is contained in:
Travis
parent
ea0dd268a4
commit
a6b7203ed9
466 changed files with 8842 additions and 611734 deletions
|
|
@ -12,7 +12,7 @@
|
|||
<link rel="shortcut icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAUAAAAF////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAIAAABbAAAAlQAAAKIAAACbAAAAmwAAAKIAAACVAAAAWwAAAAL///8A////AP///wD///8A////AAAAABQAAADAAAAAYwAAAA3///8A////AP///wD///8AAAAADQAAAGMAAADAAAAAFP///wD///8A////AP///wAAAACdAAAAOv///wD///8A////AP///wD///8A////AP///wD///8AAAAAOgAAAJ3///8A////AP///wAAAAAnAAAAcP///wAAAAAoAAAASv///wD///8A////AP///wAAAABKAAAAKP///wAAAABwAAAAJ////wD///8AAAAAgQAAABwAAACIAAAAkAAAAJMAAACtAAAAFQAAABUAAACtAAAAkwAAAJAAAACIAAAAHAAAAIH///8A////AAAAAKQAAACrAAAAaP///wD///8AAAAARQAAANIAAADSAAAARf///wD///8AAAAAaAAAAKsAAACk////AAAAADMAAACcAAAAnQAAABj///8A////AP///wAAAAAYAAAAGP///wD///8A////AAAAABgAAACdAAAAnAAAADMAAAB1AAAAwwAAAP8AAADpAAAAsQAAAE4AAAAb////AP///wAAAAAbAAAATgAAALEAAADpAAAA/wAAAMMAAAB1AAAAtwAAAOkAAAD/AAAA/wAAAP8AAADvAAAA3gAAAN4AAADeAAAA3gAAAO8AAAD/AAAA/wAAAP8AAADpAAAAtwAAAGUAAAA/AAAA3wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAADfAAAAPwAAAGX///8A////AAAAAEgAAADtAAAAvwAAAL0AAADGAAAA7wAAAO8AAADGAAAAvQAAAL8AAADtAAAASP///wD///8A////AP///wD///8AAAAAO////wD///8A////AAAAAIcAAACH////AP///wD///8AAAAAO////wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A//8AAP//AAD4HwAA7/cAAN/7AAD//wAAoYUAAJ55AACf+QAAh+EAAAAAAADAAwAA4AcAAP5/AAD//wAA//8AAA=="/>
|
||||
|
||||
<!-- Google fonts -->
|
||||
<link href='https://fonts.googleapis.com/css?family=Raleway:400,600,900' rel='stylesheet' type='text/css'/>
|
||||
<link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
|
||||
<link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
|
||||
|
||||
<!-- CSS -->
|
||||
|
|
@ -45,18 +45,19 @@ html {
|
|||
|
||||
/* Where we want fancier font if available */
|
||||
h1, h2, h3, h4, h5, h6, p.module-desc, table.docinfo + blockquote p, table.docinfo blockquote p, h1 + blockquote p {
|
||||
font-family: "Raleway", "Helvetica Neue", "HelveticaNeue", Helvetica, Arial, sans-serif !important; }
|
||||
font-family: "Lato", "Helvetica Neue", "HelveticaNeue", Helvetica, Arial, sans-serif !important; }
|
||||
|
||||
h1.title {
|
||||
font-weight: 900; }
|
||||
|
||||
body {
|
||||
font-family: "Helvetica Neue", "HelveticaNeue", "Raleway", Helvetica, Arial, sans-serif;
|
||||
font-family: "Lato", "Helvetica Neue", "HelveticaNeue", Helvetica, Arial, sans-serif;
|
||||
font-weight: 400;
|
||||
font-size: 14px;
|
||||
font-size: 16px;
|
||||
line-height: 20px;
|
||||
color: #666;
|
||||
background-color: rgba(252, 248, 244, 0.75); }
|
||||
color: #444;
|
||||
letter-spacing: 0.15px;
|
||||
background-color: rgba(252, 248, 244, 0.45); }
|
||||
|
||||
/* Skeleton grid */
|
||||
.container {
|
||||
|
|
@ -172,8 +173,8 @@ cite {
|
|||
font-style: italic !important; }
|
||||
|
||||
dt > pre {
|
||||
border-color: rgba(0, 0, 0, 0.15);
|
||||
background-color: transparent;
|
||||
border-color: rgba(0, 0, 0, 0.1);
|
||||
background-color: rgba(255, 255, 255, 0.3);
|
||||
margin: 15px 0px 5px; }
|
||||
|
||||
dd > pre {
|
||||
|
|
@ -190,6 +191,17 @@ dd > pre {
|
|||
width: 100%;
|
||||
table-layout: fixed; }
|
||||
|
||||
/* Nim search input */
|
||||
div#searchInput {
|
||||
margin-bottom: 8px;
|
||||
}
|
||||
div#searchInput input#searchInput {
|
||||
width: 10em;
|
||||
}
|
||||
div.search-groupby {
|
||||
margin-bottom: 8px;
|
||||
}
|
||||
|
||||
table.line-nums-table {
|
||||
border-radius: 4px;
|
||||
border: 1px solid #cccccc;
|
||||
|
|
@ -333,7 +345,7 @@ img {
|
|||
box-shadow: 0 1px 3px rgba(0, 0, 0, 0.1); }
|
||||
|
||||
p {
|
||||
margin: 0 0 12px; }
|
||||
margin: 0 0 8px; }
|
||||
|
||||
small {
|
||||
font-size: 85%; }
|
||||
|
|
@ -353,7 +365,7 @@ h3,
|
|||
h4,
|
||||
h5,
|
||||
h6 {
|
||||
font-family: "Helvetica Neue", "HelveticaNeue", "Raleway", Helvetica, Arial, sans-serif;
|
||||
font-family: "Lato", "Helvetica Neue", "HelveticaNeue", Helvetica, Arial, sans-serif;
|
||||
font-weight: 600;
|
||||
line-height: 20px;
|
||||
color: inherit;
|
||||
|
|
@ -361,6 +373,7 @@ h6 {
|
|||
|
||||
h1 {
|
||||
font-size: 2em;
|
||||
font-weight: 400;
|
||||
padding-bottom: .15em;
|
||||
border-bottom: 1px solid #aaaaaa;
|
||||
margin-top: 1.0em;
|
||||
|
|
@ -491,13 +504,13 @@ pre {
|
|||
box-sizing: border-box;
|
||||
min-width: calc(100% - 19.5px);
|
||||
padding: 9.5px;
|
||||
margin: 0.25em 10px 0.25em 10px;
|
||||
font-size: 14px;
|
||||
margin: 0.25em 10px 10px 10px;
|
||||
font-size: 15px;
|
||||
line-height: 20px;
|
||||
white-space: pre !important;
|
||||
overflow-y: hidden;
|
||||
overflow-x: visible;
|
||||
background-color: whitesmoke;
|
||||
background-color: rgba(0, 0, 0, 0.01);
|
||||
border: 1px solid #cccccc;
|
||||
-webkit-border-radius: 4px;
|
||||
-moz-border-radius: 4px;
|
||||
|
|
@ -776,14 +789,14 @@ div.admonition p.admonition-title, div.hint p.admonition-title,
|
|||
div.important p.admonition-title, div.note p.admonition-title,
|
||||
div.tip p.admonition-title {
|
||||
font-weight: bold;
|
||||
font-family: "Helvetica Neue", "HelveticaNeue", "Raleway", Helvetica, Arial, sans-serif; }
|
||||
font-family: "Lato", "Helvetica Neue", "HelveticaNeue", Helvetica, Arial, sans-serif; }
|
||||
|
||||
div.attention p.admonition-title, div.caution p.admonition-title,
|
||||
div.danger p.admonition-title, div.error p.admonition-title,
|
||||
div.warning p.admonition-title, .code .error {
|
||||
color: #b30000;
|
||||
font-weight: bold;
|
||||
font-family: "Helvetica Neue", "HelveticaNeue", "Raleway", Helvetica, Arial, sans-serif; }
|
||||
font-family: "Lato", "Helvetica Neue", "HelveticaNeue", Helvetica, Arial, sans-serif; }
|
||||
|
||||
/* Uncomment (and remove this text!) to get reduced vertical space in
|
||||
compound paragraphs.
|
||||
|
|
@ -830,7 +843,7 @@ div.sidebar {
|
|||
clear: right; }
|
||||
|
||||
div.sidebar p.rubric {
|
||||
font-family: "Helvetica Neue", "HelveticaNeue", "Raleway", Helvetica, Arial, sans-serif;
|
||||
font-family: "Lato", "Helvetica Neue", "HelveticaNeue", Helvetica, Arial, sans-serif;
|
||||
font-size: medium; }
|
||||
|
||||
div.system-messages {
|
||||
|
|
@ -937,12 +950,12 @@ p.rubric {
|
|||
text-align: center; }
|
||||
|
||||
p.sidebar-title {
|
||||
font-family: "Helvetica Neue", "HelveticaNeue", "Raleway", Helvetica, Arial, sans-serif;
|
||||
font-family: "Lato", "Helvetica Neue", "HelveticaNeue", Helvetica, Arial, sans-serif;
|
||||
font-weight: bold;
|
||||
font-size: larger; }
|
||||
|
||||
p.sidebar-subtitle {
|
||||
font-family: "Helvetica Neue", "HelveticaNeue", "Raleway", Helvetica, Arial, sans-serif;
|
||||
font-family: "Lato", "Helvetica Neue", "HelveticaNeue", Helvetica, Arial, sans-serif;
|
||||
font-weight: bold; }
|
||||
|
||||
p.topic-title {
|
||||
|
|
@ -984,15 +997,15 @@ pre.code .inserted, code .inserted {
|
|||
background-color: #A3D289; }
|
||||
|
||||
span.classifier {
|
||||
font-family: "Helvetica Neue", "HelveticaNeue", "Raleway", Helvetica, Arial, sans-serif;
|
||||
font-family: "Lato", "Helvetica Neue", "HelveticaNeue", Helvetica, Arial, sans-serif;
|
||||
font-style: oblique; }
|
||||
|
||||
span.classifier-delimiter {
|
||||
font-family: "Helvetica Neue", "HelveticaNeue", "Raleway", Helvetica, Arial, sans-serif;
|
||||
font-family: "Lato", "Helvetica Neue", "HelveticaNeue", Helvetica, Arial, sans-serif;
|
||||
font-weight: bold; }
|
||||
|
||||
span.interpreted {
|
||||
font-family: "Helvetica Neue", "HelveticaNeue", "Raleway", Helvetica, Arial, sans-serif; }
|
||||
font-family: "Lato", "Helvetica Neue", "HelveticaNeue", Helvetica, Arial, sans-serif; }
|
||||
|
||||
span.option {
|
||||
white-space: nowrap; }
|
||||
|
|
@ -1015,7 +1028,7 @@ table.docinfo {
|
|||
margin: 0em;
|
||||
margin-top: 2em;
|
||||
margin-bottom: 2em;
|
||||
font-family: "Raleway", "Helvetica Neue", "HelveticaNeue", Helvetica, Arial, sans-serif !important;
|
||||
font-family: "Lato", "Helvetica Neue", "HelveticaNeue", Helvetica, Arial, sans-serif !important;
|
||||
color: #444444; }
|
||||
|
||||
table.docutils {
|
||||
|
|
@ -1145,15 +1158,15 @@ dt pre > span.Operator ~ span.Identifier, dt pre > span.Operator ~ span.Operator
|
|||
background-repeat: no-repeat;
|
||||
background-image: url("data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAUAAAAF////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAIAAABbAAAAlQAAAKIAAACbAAAAmwAAAKIAAACVAAAAWwAAAAL///8A////AP///wD///8A////AAAAABQAAADAAAAAYwAAAA3///8A////AP///wD///8AAAAADQAAAGMAAADAAAAAFP///wD///8A////AP///wAAAACdAAAAOv///wD///8A////AP///wD///8A////AP///wD///8AAAAAOgAAAJ3///8A////AP///wAAAAAnAAAAcP///wAAAAAoAAAASv///wD///8A////AP///wAAAABKAAAAKP///wAAAABwAAAAJ////wD///8AAAAAgQAAABwAAACIAAAAkAAAAJMAAACtAAAAFQAAABUAAACtAAAAkwAAAJAAAACIAAAAHAAAAIH///8A////AAAAAKQAAACrAAAAaP///wD///8AAAAARQAAANIAAADSAAAARf///wD///8AAAAAaAAAAKsAAACk////AAAAADMAAACcAAAAnQAAABj///8A////AP///wAAAAAYAAAAGP///wD///8A////AAAAABgAAACdAAAAnAAAADMAAAB1AAAAwwAAAP8AAADpAAAAsQAAAE4AAAAb////AP///wAAAAAbAAAATgAAALEAAADpAAAA/wAAAMMAAAB1AAAAtwAAAOkAAAD/AAAA/wAAAP8AAADvAAAA3gAAAN4AAADeAAAA3gAAAO8AAAD/AAAA/wAAAP8AAADpAAAAtwAAAGUAAAA/AAAA3wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAADfAAAAPwAAAGX///8A////AAAAAEgAAADtAAAAvwAAAL0AAADGAAAA7wAAAO8AAADGAAAAvQAAAL8AAADtAAAASP///wD///8A////AP///wD///8AAAAAO////wD///8A////AAAAAIcAAACH////AP///wD///8AAAAAO////wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A//8AAP//AAD4HwAA7/cAAN/7AAD//wAAoYUAAJ55AACf+QAAh+EAAAAAAADAAwAA4AcAAP5/AAD//wAA//8AAA==");
|
||||
margin-bottom: -5px; }
|
||||
div.pragma {
|
||||
display: none;
|
||||
}
|
||||
span.pragmabegin {
|
||||
cursor: pointer;
|
||||
}
|
||||
span.pragmaend {
|
||||
cursor: pointer;
|
||||
}
|
||||
div.pragma {
|
||||
display: none;
|
||||
}
|
||||
span.pragmabegin {
|
||||
cursor: pointer;
|
||||
}
|
||||
span.pragmaend {
|
||||
cursor: pointer;
|
||||
}
|
||||
|
||||
div.search_results {
|
||||
background-color: antiquewhite;
|
||||
|
|
@ -1161,6 +1174,11 @@ div.search_results {
|
|||
padding: 1em;
|
||||
border: 1px solid #4d4d4d;
|
||||
}
|
||||
|
||||
div#global-links ul {
|
||||
margin-left: 0;
|
||||
list-style-type: none;
|
||||
}
|
||||
</style>
|
||||
|
||||
<script type="text/javascript" src="../dochack.js"></script>
|
||||
|
|
@ -1198,7 +1216,11 @@ function main() {
|
|||
<h1 class="title">Module godotapigen</h1>
|
||||
<div class="row">
|
||||
<div class="three columns">
|
||||
<div>
|
||||
<div id="global-links">
|
||||
<ul class="simple">
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchInput">
|
||||
Search: <input type="text" id="searchInput"
|
||||
onkeyup="search()" />
|
||||
</div>
|
||||
|
|
@ -1220,7 +1242,7 @@ function main() {
|
|||
<a class="reference reference-toplevel" href="#12" id="62">Procs</a>
|
||||
<ul class="simple simple-toc-section">
|
||||
<li><a class="reference" href="#genApi,string,string"
|
||||
title="genApi*(targetDir: string; apiJsonFile: string)"><wbr />gen<wbr />Api<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
title="genApi(targetDir: string; apiJsonFile: string)"><wbr />gen<wbr />Api<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
|
|
@ -1234,16 +1256,18 @@ function main() {
|
|||
<div class="section" id="6">
|
||||
<h1><a class="toc-backref" href="#6">Imports</a></h1>
|
||||
<dl class="item">
|
||||
<a class="reference external" href="streams.html">streams</a>, <a class="reference external" href="json.html">json</a>, <a class="reference external" href="os.html">os</a>, <a class="reference external" href="strutils.html">strutils</a>, <a class="reference external" href="times.html">times</a>, <a class="reference external" href="sets.html">sets</a>, <a class="reference external" href="tables.html">tables</a>, <a class="reference external" href="sequtils.html">sequtils</a>, <a class="reference external" href="algorithm.html">algorithm</a>, <a class="reference external" href="compiler/[ast,renderer,idents,astalgo].html">compiler/[ast,renderer,idents,astalgo]</a>, <a class="reference external" href="os.html">os</a>
|
||||
<a class="reference external" href="streams.html">streams</a>, <a class="reference external" href="json.html">json</a>, <a class="reference external" href="os.html">os</a>, <a class="reference external" href="strutils.html">strutils</a>, <a class="reference external" href="times.html">times</a>, <a class="reference external" href="sets.html">sets</a>, <a class="reference external" href="tables.html">tables</a>, <a class="reference external" href="sequtils.html">sequtils</a>, <a class="reference external" href="algorithm.html">algorithm</a>, <a class="reference external" href="compiler/ast.html">compiler/ast</a>, <a class="reference external" href="compiler/renderer.html">compiler/renderer</a>, <a class="reference external" href="compiler/idents.html">compiler/idents</a>, <a class="reference external" href="compiler/astalgo.html">compiler/astalgo</a>, <a class="reference external" href="os.html">os</a>
|
||||
</dl></div>
|
||||
<div class="section" id="12">
|
||||
<h1><a class="toc-backref" href="#12">Procs</a></h1>
|
||||
<dl class="item">
|
||||
<dt id="genApi"><a name="genApi,string,string"></a><pre><span class="Keyword">proc</span> <span class="Identifier">genApi</span><span class="Operator">*</span><span class="Other">(</span><span class="Identifier">targetDir</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">apiJsonFile</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span></pre></dt>
|
||||
<dt id="genApi"><a name="genApi,string,string"></a><pre><span class="Keyword">proc</span> <span class="Identifier">genApi</span><span class="Other">(</span><span class="Identifier">targetDir</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">apiJsonFile</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">raises</span><span class="Other">:</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="Identifier">JsonParsingError</span><span class="Other">,</span> <span class="Identifier">KeyError</span><span class="Other">,</span> <span class="Identifier">AssertionError</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">ReadIOEffect</span><span class="Other">,</span> <span class="Identifier">WriteIOEffect</span><span class="Other">,</span> <span class="Identifier">RootEffect</span><span class="Other">]</span></div><span class="Other pragmaend">.}</span></pre></dt>
|
||||
<dd>
|
||||
Generates .nim files in the <tt class="docutils literal"><span class="pre">targetDir</span></tt> based on the <tt class="docutils literal"><span class="pre">apiJsonFile</span></tt>. The JSON file can be generated by executing Godot with <tt class="docutils literal"><span class="pre">--gdnative-generate-json-api <target_filename></span></tt> parameters.
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/7e230480488d066eebf41dc594ca363bb28fcaf1/godot/godotapigen.nim#L821"
|
||||
href="https://github.com/pragmagic/godot-nim/tree/72dd992e6644846c84363af3baab3c4020abdcca/godot/godotapigen.nim#L821"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/godotapigen.nim#L821" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
|
|
@ -1258,7 +1282,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small>Made with Nim. Generated: 2017-08-23 14:53:55 UTC</small>
|
||||
<small>Made with Nim. Generated: 2017-12-10 10:58:27 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue