Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP: Doc/update #7

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
277 changes: 166 additions & 111 deletions docs/array.html

Large diffs are not rendered by default.

154 changes: 144 additions & 10 deletions docs/boolean.html
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,15 @@
</li>
</a>

<a href="base_object.html">
<a href="boolean.html">
<li class="">
BaseObject
Boolean
</li>
</a>

<a href="boolean.html">
<a href="channel.html">
<li class="">
Boolean
Channel
</li>
</a>

Expand Down Expand Up @@ -66,6 +66,12 @@
</li>
</a>

<a href="http.html">
<li class="">
Http
</li>
</a>

<a href="integer.html">
<li class="">
Integer
Expand All @@ -90,12 +96,36 @@
</li>
</a>

<a href="plugin.html">
<li class="">
Plugin
</li>
</a>

<a href="range.html">
<li class="">
Range
</li>
</a>

<a href="string.html">
<li class="">
String
</li>
</a>

<a href="struct.html">
<li class="">
Struct
</li>
</a>

<a href="uri.html">
<li class="">
Uri
</li>
</a>

</ul>
</div>

Expand All @@ -106,7 +136,8 @@ <h1 class="class_name">Boolean</h1>
<h2>Description</h2>
<hr />
<div><p>BooleanObject represents boolean object in goby.
It includes <code>true</code> and <code>FALSE</code> which represents logically true and false value.</p>
It includes <code>true</code> and <code>FALSE</code> which represents logically true and false value.
- <code>Boolean.new</code> is not supported.</p>
</div>

<h2>Class Methods</h2>
Expand All @@ -125,21 +156,44 @@ <h4 class="method">
<span>==</span>


<span class="return-separator"> => </span>




<span><a class="class-link"href="Boolean.html">Boolean</a></span>



</p>
</h4>
<div class="method-comment">
<div>
<p>Returns true if the receiver equals to the argument.</p>

<pre><code class="language-Ruby"> 1 == 1 # =&gt; true
100 == 33 # =&gt; false
</code></pre>

</div>
<div>



<ul>
<li>
<span><span class="bold">Return: </span>(<a class="class-link"href="Boolean.html">Boolean</a>) : </span>

<span class="note">No Doc</span>

</li>
</ul>


</div>
</div>
<p class="source">
(<a href="https://github.com/goby-lang/goby/tree/64069b9916f61d76ee828d3983c5269e0dd037b3/vm/boolean.go#L50" target="_blank">
(<a href="https://github.com/goby-lang/goby/tree/25cfac50126b3cad0a28ba1334176b9d70a2ee04/vm/boolean.go#L56" target="_blank">
source
</a>)
</p>
Expand All @@ -150,21 +204,44 @@ <h4 class="method">
<span>!=</span>


<span class="return-separator"> => </span>




<span><a class="class-link"href="Boolean.html">Boolean</a></span>



</p>
</h4>
<div class="method-comment">
<div>
<p>Returns true if the receiver is not equals to the argument.</p>

<pre><code class="language-Ruby"> 4 != 2 # =&gt; true
45 != 45 # =&gt; false
</code></pre>

</div>
<div>



<ul>
<li>
<span><span class="bold">Return: </span>(<a class="class-link"href="Boolean.html">Boolean</a>) : </span>

<span class="note">No Doc</span>

</li>
</ul>


</div>
</div>
<p class="source">
(<a href="https://github.com/goby-lang/goby/tree/64069b9916f61d76ee828d3983c5269e0dd037b3/vm/boolean.go#L68" target="_blank">
(<a href="https://github.com/goby-lang/goby/tree/25cfac50126b3cad0a28ba1334176b9d70a2ee04/vm/boolean.go#L76" target="_blank">
source
</a>)
</p>
Expand All @@ -175,7 +252,15 @@ <h4 class="method">
<span>!</span>


<span class="return-separator"> => </span>




<span><a class="class-link"href="Boolean.html">Boolean</a></span>



</p>
</h4>
<div class="method-comment">
Expand All @@ -190,10 +275,21 @@ <h4 class="method">
<div>



<ul>
<li>
<span><span class="bold">Return: </span>(<a class="class-link"href="Boolean.html">Boolean</a>) : </span>

<span class="note">No Doc</span>

</li>
</ul>


</div>
</div>
<p class="source">
(<a href="https://github.com/goby-lang/goby/tree/64069b9916f61d76ee828d3983c5269e0dd037b3/vm/boolean.go#L91" target="_blank">
(<a href="https://github.com/goby-lang/goby/tree/25cfac50126b3cad0a28ba1334176b9d70a2ee04/vm/boolean.go#L95" target="_blank">
source
</a>)
</p>
Expand All @@ -204,7 +300,15 @@ <h4 class="method">
<span>&amp;&amp;</span>


<span class="return-separator"> => </span>




<span><a class="class-link"href="Boolean.html">Boolean</a></span>



</p>
</h4>
<div class="method-comment">
Expand All @@ -219,10 +323,21 @@ <h4 class="method">
<div>



<ul>
<li>
<span><span class="bold">Return: </span>(<a class="class-link"href="Boolean.html">Boolean</a>) : </span>

<span class="note">No Doc</span>

</li>
</ul>


</div>
</div>
<p class="source">
(<a href="https://github.com/goby-lang/goby/tree/64069b9916f61d76ee828d3983c5269e0dd037b3/vm/boolean.go#L112" target="_blank">
(<a href="https://github.com/goby-lang/goby/tree/25cfac50126b3cad0a28ba1334176b9d70a2ee04/vm/boolean.go#L117" target="_blank">
source
</a>)
</p>
Expand All @@ -233,7 +348,15 @@ <h4 class="method">
<span>||</span>


<span class="return-separator"> => </span>




<span><a class="class-link"href="Boolean.html">Boolean</a></span>



</p>
</h4>
<div class="method-comment">
Expand All @@ -249,10 +372,21 @@ <h4 class="method">
<div>



<ul>
<li>
<span><span class="bold">Return: </span>(<a class="class-link"href="Boolean.html">Boolean</a>) : </span>

<span class="note">No Doc</span>

</li>
</ul>


</div>
</div>
<p class="source">
(<a href="https://github.com/goby-lang/goby/tree/64069b9916f61d76ee828d3983c5269e0dd037b3/vm/boolean.go#L141" target="_blank">
(<a href="https://github.com/goby-lang/goby/tree/25cfac50126b3cad0a28ba1334176b9d70a2ee04/vm/boolean.go#L148" target="_blank">
source
</a>)
</p>
Expand Down