Update master documentation for changeset f05eb090f7

This commit is contained in:
Travis 2018-01-25 12:11:35 +00:00
commit 46a1aa6700
31 changed files with 1586 additions and 1583 deletions

View file

@ -1241,9 +1241,7 @@ function main() {
<li>
<a class="reference reference-toplevel" href="#12" id="62">Procs</a>
<ul class="simple simple-toc-section">
<li><a class="reference" href="#len,GodotString"
title="len(self: GodotString): cint"><wbr />len<span class="attachedType" style="visibility:hidden"></span></a></li>
<li><a class="reference" href="#==,GodotString,GodotString"
<li><a class="reference" href="#==,GodotString,GodotString"
title="`==`(self, b: GodotString): bool"><wbr />`==`<span class="attachedType" style="visibility:hidden"></span></a></li>
<li><a class="reference" href="#<,GodotString,GodotString"
title="`&lt;`(self, b: GodotString): bool"><wbr />`&lt;`<span class="attachedType" style="visibility:hidden"></span></a></li>
@ -1275,76 +1273,67 @@ function main() {
<div class="section" id="12">
<h1><a class="toc-backref" href="#12">Procs</a></h1>
<dl class="item">
<dt id="len"><a name="len,GodotString"></a><pre><span class="Keyword">proc</span> <span class="Identifier">len</span><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <span class="Identifier">GodotString</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">cint</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">inline</span><span class="Other">,</span> <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></div><span class="Other pragmaend">.}</span></pre></dt>
<dd>
Returns the length of string in bytes if it is represented as UTF-8.
&nbsp;&nbsp;<a
href="https://github.com/pragmagic/godot-nim/tree/72dd992e6644846c84363af3baab3c4020abdcca/godot/internal/godotstrings.nim#L18"
class="link-seesrc" target="_blank">Source</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/internal/godotstrings.nim#L18" class="link-seesrc" target="_blank" >Edit</a>
</dd>
<dt id="=="><a name="==,GodotString,GodotString"></a><pre><span class="Keyword">proc</span> <span class="Identifier">`==`</span><span class="Other">(</span><span class="Identifier">self</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">:</span> <span class="Identifier">GodotString</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">bool</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">inline</span><span class="Other">,</span> <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></div><span class="Other pragmaend">.}</span></pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/pragmagic/godot-nim/tree/72dd992e6644846c84363af3baab3c4020abdcca/godot/internal/godotstrings.nim#L22"
href="https://github.com/pragmagic/godot-nim/tree/f05eb090f710df4aed71e6502da8258c5abbb6d9/godot/internal/godotstrings.nim#L13"
class="link-seesrc" target="_blank">Source</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/internal/godotstrings.nim#L22" class="link-seesrc" target="_blank" >Edit</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/internal/godotstrings.nim#L13" class="link-seesrc" target="_blank" >Edit</a>
</dd>
<dt id="<"><a name="<,GodotString,GodotString"></a><pre><span class="Keyword">proc</span> <span class="Identifier">`&lt;`</span><span class="Other">(</span><span class="Identifier">self</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">:</span> <span class="Identifier">GodotString</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">bool</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">inline</span><span class="Other">,</span> <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></div><span class="Other pragmaend">.}</span></pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/pragmagic/godot-nim/tree/72dd992e6644846c84363af3baab3c4020abdcca/godot/internal/godotstrings.nim#L25"
href="https://github.com/pragmagic/godot-nim/tree/f05eb090f710df4aed71e6502da8258c5abbb6d9/godot/internal/godotstrings.nim#L16"
class="link-seesrc" target="_blank">Source</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/internal/godotstrings.nim#L25" class="link-seesrc" target="_blank" >Edit</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/internal/godotstrings.nim#L16" class="link-seesrc" target="_blank" >Edit</a>
</dd>
<dt id="&"><a name="&,GodotString,GodotString"></a><pre><span class="Keyword">proc</span> <span class="Identifier">`&amp;`</span><span class="Other">(</span><span class="Identifier">self</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">:</span> <span class="Identifier">GodotString</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">GodotString</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">inline</span><span class="Other">,</span> <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></div><span class="Other pragmaend">.}</span></pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/pragmagic/godot-nim/tree/72dd992e6644846c84363af3baab3c4020abdcca/godot/internal/godotstrings.nim#L28"
href="https://github.com/pragmagic/godot-nim/tree/f05eb090f710df4aed71e6502da8258c5abbb6d9/godot/internal/godotstrings.nim#L19"
class="link-seesrc" target="_blank">Source</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/internal/godotstrings.nim#L28" class="link-seesrc" target="_blank" >Edit</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/internal/godotstrings.nim#L19" class="link-seesrc" target="_blank" >Edit</a>
</dd>
<dt id="deinit"><a name="deinit,GodotString"></a><pre><span class="Keyword">proc</span> <span class="Identifier">deinit</span><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">GodotString</span><span class="Other">)</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">inline</span><span class="Other">,</span> <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></div><span class="Other pragmaend">.}</span></pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/pragmagic/godot-nim/tree/72dd992e6644846c84363af3baab3c4020abdcca/godot/internal/godotstrings.nim#L31"
href="https://github.com/pragmagic/godot-nim/tree/f05eb090f710df4aed71e6502da8258c5abbb6d9/godot/internal/godotstrings.nim#L22"
class="link-seesrc" target="_blank">Source</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/internal/godotstrings.nim#L31" class="link-seesrc" target="_blank" >Edit</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/internal/godotstrings.nim#L22" class="link-seesrc" target="_blank" >Edit</a>
</dd>
<dt id="$"><a name="$,GodotString"></a><pre><span class="Keyword">proc</span> <span class="Identifier">`$`</span><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <span class="Identifier">GodotString</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">string</span> <span class="Other pragmabegin">{.</span><div 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></div><span class="Other pragmaend">.}</span></pre></dt>
<dd>
Converts the <tt class="docutils literal"><span class="pre">GodotString</span></tt> into Nim string
&nbsp;&nbsp;<a
href="https://github.com/pragmagic/godot-nim/tree/72dd992e6644846c84363af3baab3c4020abdcca/godot/internal/godotstrings.nim#L34"
href="https://github.com/pragmagic/godot-nim/tree/f05eb090f710df4aed71e6502da8258c5abbb6d9/godot/internal/godotstrings.nim#L25"
class="link-seesrc" target="_blank">Source</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/internal/godotstrings.nim#L34" class="link-seesrc" target="_blank" >Edit</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/internal/godotstrings.nim#L25" class="link-seesrc" target="_blank" >Edit</a>
</dd>
<dt id="toGodotString"><a name="toGodotString,string"></a><pre><span class="Keyword">proc</span> <span class="Identifier">toGodotString</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">GodotString</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">inline</span><span class="Other">,</span> <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></div><span class="Other pragmaend">.}</span></pre></dt>
<dd>
Converts the Nim string into <tt class="docutils literal"><span class="pre">GodotString</span></tt>
&nbsp;&nbsp;<a
href="https://github.com/pragmagic/godot-nim/tree/72dd992e6644846c84363af3baab3c4020abdcca/godot/internal/godotstrings.nim#L42"
href="https://github.com/pragmagic/godot-nim/tree/f05eb090f710df4aed71e6502da8258c5abbb6d9/godot/internal/godotstrings.nim#L34"
class="link-seesrc" target="_blank">Source</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/internal/godotstrings.nim#L42" class="link-seesrc" target="_blank" >Edit</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/internal/godotstrings.nim#L34" class="link-seesrc" target="_blank" >Edit</a>
</dd>
<dt id="toGodotString"><a name="toGodotString,cstring"></a><pre><span class="Keyword">proc</span> <span class="Identifier">toGodotString</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Identifier">cstring</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">GodotString</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">inline</span><span class="Other">,</span> <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></div><span class="Other pragmaend">.}</span></pre></dt>
<dd>
Converts the cstring into <tt class="docutils literal"><span class="pre">GodotString</span></tt>
&nbsp;&nbsp;<a
href="https://github.com/pragmagic/godot-nim/tree/72dd992e6644846c84363af3baab3c4020abdcca/godot/internal/godotstrings.nim#L49"
href="https://github.com/pragmagic/godot-nim/tree/f05eb090f710df4aed71e6502da8258c5abbb6d9/godot/internal/godotstrings.nim#L41"
class="link-seesrc" target="_blank">Source</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/internal/godotstrings.nim#L49" class="link-seesrc" target="_blank" >Edit</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/internal/godotstrings.nim#L41" class="link-seesrc" target="_blank" >Edit</a>
</dd>
@ -1357,7 +1346,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-12-10 10:58:41 UTC</small>
<small>Made with Nim. Generated: 2018-01-25 11:57:45 UTC</small>
</div>
</div>
</div>