Deploying to gh-pages from @ 04b19a60db 🚀

This commit is contained in:
Sija 2022-11-14 16:29:48 +00:00
parent 3b4b740467
commit 8e29336e08
121 changed files with 752 additions and 752 deletions

View file

@ -750,7 +750,7 @@
</h2>
<p>Represents the existence of the local variable.
Holds the var node and variable assigments.</p>
Holds the var node and variable assignments.</p>
@ -789,7 +789,7 @@ Holds the var node and variable assigments.</p>
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/db5eee76/src/ameba/ast/variabling/variable.cr#L4" target="_blank">
<a href="https://github.com/crystal-ameba/ameba/blob/04b19a60/src/ameba/ast/variabling/variable.cr#L4" target="_blank">
ameba/ast/variabling/variable.cr
</a>
@ -850,21 +850,21 @@ Holds the var node and variable assigments.</p>
<li class="entry-summary">
<a href="#assignments%3AArray%28Ameba%3A%3AAST%3A%3AAssignment%29-instance-method" class="signature"><strong>#assignments</strong> : Array(Ameba::AST::Assignment)</a>
<div class="summary"><p>List of the assigments of this variable.</p></div>
<div class="summary"><p>List of the assignments of this variable.</p></div>
</li>
<li class="entry-summary">
<a href="#captured_by_block%3F%28scope%3D%40scope%29-instance-method" class="signature"><strong>#captured_by_block?</strong>(scope = @scope)</a>
<div class="summary"><p>Returns true if the current var is referenced in in the block.</p></div>
<div class="summary"><p>Returns <code>true</code> if the current var is referenced in in the block.</p></div>
</li>
<li class="entry-summary">
<a href="#declared_before%3F%28node%29-instance-method" class="signature"><strong>#declared_before?</strong>(node)</a>
<div class="summary"><p>Returns true if the variable is declared before the <code><a href="../../Ameba/AST/Variable.html#node%3ACrystal%3A%3AVar-instance-method">#node</a></code>.</p></div>
<div class="summary"><p>Returns <code>true</code> if the variable is declared before the <code><a href="../../Ameba/AST/Variable.html#node%3ACrystal%3A%3AVar-instance-method">#node</a></code>.</p></div>
</li>
@ -881,14 +881,14 @@ Holds the var node and variable assigments.</p>
<li class="entry-summary">
<a href="#eql%3F%28node%29-instance-method" class="signature"><strong>#eql?</strong>(node)</a>
<div class="summary"><p>Returns true if the <code><a href="../../Ameba/AST/Variable.html#node%3ACrystal%3A%3AVar-instance-method">#node</a></code> represents exactly the same Crystal node as <code>@node</code>.</p></div>
<div class="summary"><p>Returns <code>true</code> if the <code><a href="../../Ameba/AST/Variable.html#node%3ACrystal%3A%3AVar-instance-method">#node</a></code> represents exactly the same Crystal node as <code>@node</code>.</p></div>
</li>
<li class="entry-summary">
<a href="#ignored%3F-instance-method" class="signature"><strong>#ignored?</strong></a>
<div class="summary"><p>Returns true if the name starts with '_', false if not.</p></div>
<div class="summary"><p>Returns <code>true</code> if the name starts with '_', <code>false</code> if not.</p></div>
</li>
@ -936,7 +936,7 @@ Holds the var node and variable assigments.</p>
<li class="entry-summary">
<a href="#referenced%3F-instance-method" class="signature"><strong>#referenced?</strong></a>
<div class="summary"><p>Returns true if variable has any reference.</p></div>
<div class="summary"><p>Returns <code>true</code> if variable has any reference.</p></div>
</li>
@ -957,14 +957,14 @@ Holds the var node and variable assigments.</p>
<li class="entry-summary">
<a href="#special%3F-instance-method" class="signature"><strong>#special?</strong></a>
<div class="summary"><p>Returns true if it is a special variable, i.e <code>$?</code>.</p></div>
<div class="summary"><p>Returns <code>true</code> if it is a special variable, i.e <code>$?</code>.</p></div>
</li>
<li class="entry-summary">
<a href="#target_of%3F%28assign%29-instance-method" class="signature"><strong>#target_of?</strong>(assign)</a>
<div class="summary"><p>Returns true if the variable is a target (on the left) of the assignment, false otherwise.</p></div>
<div class="summary"><p>Returns <code>true</code> if the variable is a target (on the left) of the assignment, <code>false</code> otherwise.</p></div>
</li>
@ -981,7 +981,7 @@ Holds the var node and variable assigments.</p>
<li class="entry-summary">
<a href="#used_in_macro%3F%28scope%3D%40scope%29-instance-method" class="signature"><strong>#used_in_macro?</strong>(scope = @scope)</a>
<div class="summary"><p>Returns true if current variable potentially referenced in a macro, false if not.</p></div>
<div class="summary"><p>Returns <code>true</code> if current variable potentially referenced in a macro, <code>false</code> if not.</p></div>
</li>
@ -1042,7 +1042,7 @@ Holds the var node and variable assigments.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/db5eee76/src/ameba/ast/variabling/variable.cr#L30" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/04b19a60/src/ameba/ast/variabling/variable.cr#L30" target="_blank">View source</a>]
</div>
</div>
@ -1082,7 +1082,7 @@ variable.assignment.size <span class="c"># =&gt; 2</span></code></pre>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/db5eee76/src/ameba/ast/variabling/variable.cr#L47" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/04b19a60/src/ameba/ast/variabling/variable.cr#L47" target="_blank">View source</a>]
</div>
</div>
@ -1103,7 +1103,7 @@ variable.assignment.size <span class="c"># =&gt; 2</span></code></pre>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/db5eee76/src/ameba/ast/variabling/variable.cr#L18" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/04b19a60/src/ameba/ast/variabling/variable.cr#L18" target="_blank">View source</a>]
</div>
</div>
@ -1118,13 +1118,13 @@ variable.assignment.size <span class="c"># =&gt; 2</span></code></pre>
<div class="doc">
<p>List of the assigments of this variable.</p>
<p>List of the assignments of this variable.</p>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/db5eee76/src/ameba/ast/variabling/variable.cr#L6" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/04b19a60/src/ameba/ast/variabling/variable.cr#L6" target="_blank">View source</a>]
</div>
</div>
@ -1139,7 +1139,7 @@ variable.assignment.size <span class="c"># =&gt; 2</span></code></pre>
<div class="doc">
<p>Returns true if the current var is referenced in
<p>Returns <code>true</code> if the current var is referenced in
in the block. For example this variable is captured
by block:</p>
<pre><code class="language-crystal">a <span class="o">=</span> <span class="n">1</span>
@ -1152,7 +1152,7 @@ by block:</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/db5eee76/src/ameba/ast/variabling/variable.cr#L111" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/04b19a60/src/ameba/ast/variabling/variable.cr#L111" target="_blank">View source</a>]
</div>
</div>
@ -1167,13 +1167,13 @@ by block:</p>
<div class="doc">
<p>Returns true if the variable is declared before the <code><a href="../../Ameba/AST/Variable.html#node%3ACrystal%3A%3AVar-instance-method">#node</a></code>.</p>
<p>Returns <code>true</code> if the variable is declared before the <code><a href="../../Ameba/AST/Variable.html#node%3ACrystal%3A%3AVar-instance-method">#node</a></code>.</p>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/db5eee76/src/ameba/ast/variabling/variable.cr#L158" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/04b19a60/src/ameba/ast/variabling/variable.cr#L161" target="_blank">View source</a>]
</div>
</div>
@ -1189,7 +1189,7 @@ by block:</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/db5eee76/src/ameba/ast/variabling/variable.cr#L21" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/04b19a60/src/ameba/ast/variabling/variable.cr#L21" target="_blank">View source</a>]
</div>
</div>
@ -1205,7 +1205,7 @@ by block:</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/db5eee76/src/ameba/ast/variabling/variable.cr#L21" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/04b19a60/src/ameba/ast/variabling/variable.cr#L21" target="_blank">View source</a>]
</div>
</div>
@ -1220,14 +1220,14 @@ by block:</p>
<div class="doc">
<p>Returns true if the <code><a href="../../Ameba/AST/Variable.html#node%3ACrystal%3A%3AVar-instance-method">#node</a></code> represents exactly
<p>Returns <code>true</code> if the <code><a href="../../Ameba/AST/Variable.html#node%3ACrystal%3A%3AVar-instance-method">#node</a></code> represents exactly
the same Crystal node as <code>@node</code>.</p>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/db5eee76/src/ameba/ast/variabling/variable.cr#L151" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/04b19a60/src/ameba/ast/variabling/variable.cr#L154" target="_blank">View source</a>]
</div>
</div>
@ -1242,13 +1242,13 @@ the same Crystal node as <code>@node</code>.</p>
<div class="doc">
<p>Returns true if the name starts with '_', false if not.</p>
<p>Returns <code>true</code> if the name starts with '_', <code>false</code> if not.</p>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/db5eee76/src/ameba/ast/variabling/variable.cr#L145" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/04b19a60/src/ameba/ast/variabling/variable.cr#L148" target="_blank">View source</a>]
</div>
</div>
@ -1264,7 +1264,7 @@ the same Crystal node as <code>@node</code>.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/db5eee76/src/ameba/ast/variabling/variable.cr#L20" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/04b19a60/src/ameba/ast/variabling/variable.cr#L20" target="_blank">View source</a>]
</div>
</div>
@ -1280,7 +1280,7 @@ the same Crystal node as <code>@node</code>.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/db5eee76/src/ameba/ast/variabling/variable.cr#L20" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/04b19a60/src/ameba/ast/variabling/variable.cr#L20" target="_blank">View source</a>]
</div>
</div>
@ -1296,7 +1296,7 @@ the same Crystal node as <code>@node</code>.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/db5eee76/src/ameba/ast/variabling/variable.cr#L22" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/04b19a60/src/ameba/ast/variabling/variable.cr#L22" target="_blank">View source</a>]
</div>
</div>
@ -1312,7 +1312,7 @@ the same Crystal node as <code>@node</code>.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/db5eee76/src/ameba/ast/variabling/variable.cr#L22" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/04b19a60/src/ameba/ast/variabling/variable.cr#L22" target="_blank">View source</a>]
</div>
</div>
@ -1333,7 +1333,7 @@ the same Crystal node as <code>@node</code>.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/db5eee76/src/ameba/ast/variabling/variable.cr#L12" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/04b19a60/src/ameba/ast/variabling/variable.cr#L12" target="_blank">View source</a>]
</div>
</div>
@ -1356,7 +1356,7 @@ variable.reference(var_node, some_scope)</code></pre>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/db5eee76/src/ameba/ast/variabling/variable.cr#L70" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/04b19a60/src/ameba/ast/variabling/variable.cr#L70" target="_blank">View source</a>]
</div>
</div>
@ -1380,7 +1380,7 @@ variable.reference_assignments!</code></pre>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/db5eee76/src/ameba/ast/variabling/variable.cr#L84" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/04b19a60/src/ameba/ast/variabling/variable.cr#L84" target="_blank">View source</a>]
</div>
</div>
@ -1395,7 +1395,7 @@ variable.reference_assignments!</code></pre>
<div class="doc">
<p>Returns true if variable has any reference.</p>
<p>Returns <code>true</code> if variable has any reference.</p>
<pre><code class="language-crystal">variable <span class="o">=</span> <span class="t">Variable</span>.new(node, scope)
variable.reference(var_node)
variable.referenced? <span class="c"># =&gt; true</span></code></pre>
@ -1404,7 +1404,7 @@ variable.referenced? <span class="c"># =&gt; true</span></code></pre>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/db5eee76/src/ameba/ast/variabling/variable.cr#L60" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/04b19a60/src/ameba/ast/variabling/variable.cr#L60" target="_blank">View source</a>]
</div>
</div>
@ -1425,7 +1425,7 @@ variable.referenced? <span class="c"># =&gt; true</span></code></pre>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/db5eee76/src/ameba/ast/variabling/variable.cr#L9" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/04b19a60/src/ameba/ast/variabling/variable.cr#L9" target="_blank">View source</a>]
</div>
</div>
@ -1446,7 +1446,7 @@ variable.referenced? <span class="c"># =&gt; true</span></code></pre>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/db5eee76/src/ameba/ast/variabling/variable.cr#L15" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/04b19a60/src/ameba/ast/variabling/variable.cr#L15" target="_blank">View source</a>]
</div>
</div>
@ -1461,13 +1461,13 @@ variable.referenced? <span class="c"># =&gt; true</span></code></pre>
<div class="doc">
<p>Returns true if it is a special variable, i.e <code>$?</code>.</p>
<p>Returns <code>true</code> if it is a special variable, i.e <code>$?</code>.</p>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/db5eee76/src/ameba/ast/variabling/variable.cr#L34" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/04b19a60/src/ameba/ast/variabling/variable.cr#L34" target="_blank">View source</a>]
</div>
</div>
@ -1482,14 +1482,14 @@ variable.referenced? <span class="c"># =&gt; true</span></code></pre>
<div class="doc">
<p>Returns true if the variable is a target (on the left) of the assignment,
false otherwise.</p>
<p>Returns <code>true</code> if the variable is a target (on the left) of the assignment,
<code>false</code> otherwise.</p>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/db5eee76/src/ameba/ast/variabling/variable.cr#L133" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/04b19a60/src/ameba/ast/variabling/variable.cr#L136" target="_blank">View source</a>]
</div>
</div>
@ -1505,7 +1505,7 @@ false otherwise.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/db5eee76/src/ameba/ast/variabling/variable.cr#L23" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/04b19a60/src/ameba/ast/variabling/variable.cr#L23" target="_blank">View source</a>]
</div>
</div>
@ -1521,7 +1521,7 @@ false otherwise.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/db5eee76/src/ameba/ast/variabling/variable.cr#L23" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/04b19a60/src/ameba/ast/variabling/variable.cr#L23" target="_blank">View source</a>]
</div>
</div>
@ -1536,14 +1536,14 @@ false otherwise.</p>
<div class="doc">
<p>Returns true if current variable potentially referenced in a macro,
false if not.</p>
<p>Returns <code>true</code> if current variable potentially referenced in a macro,
<code>false</code> if not.</p>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/db5eee76/src/ameba/ast/variabling/variable.cr#L122" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/04b19a60/src/ameba/ast/variabling/variable.cr#L123" target="_blank">View source</a>]
</div>
</div>