Deploying to gh-pages from @ crystal-ameba/ameba@e1f5c81804 🚀

This commit is contained in:
Sija 2023-06-14 14:56:05 +00:00
parent 3038eba7a2
commit 26e6de35c6
129 changed files with 846 additions and 839 deletions

View file

@ -798,7 +798,13 @@
modules, classes, enums, methods and macros.</p>
<p>YAML configuration example:</p>
<pre><code class="language-crystal"><span class="t">Lint</span><span class="o">/</span><span class="t">Documentation</span>:
<span class="t">Enabled</span>: <span class="n">true</span></code></pre>
<span class="t">Enabled</span>: <span class="n">true</span>
<span class="t">IgnoreClasses</span>: <span class="n">false</span>
<span class="t">IgnoreModules</span>: <span class="n">true</span>
<span class="t">IgnoreEnums</span>: <span class="n">false</span>
<span class="t">IgnoreDefs</span>: <span class="n">true</span>
<span class="t">IgnoreMacros</span>: <span class="n">false</span>
<span class="t">IgnoreMacroHooks</span>: <span class="n">true</span></code></pre>
@ -839,7 +845,7 @@ modules, classes, enums, methods and macros.</p>
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/b4244d4/src/ameba/rule/lint/documentation.cr#L11" target="_blank">
<a href="https://github.com/crystal-ameba/ameba/blob/e1f5c81/src/ameba/rule/lint/documentation.cr#L17" target="_blank">
ameba/rule/lint/documentation.cr
</a>
@ -991,6 +997,16 @@ modules, classes, enums, methods and macros.</p>
</li>
<li class="entry-summary">
<a href="#ignore_macro_hooks%3D%28ignore_macro_hooks%3ABool%29-instance-method" class="signature"><strong>#ignore_macro_hooks=</strong>(ignore_macro_hooks : Bool)</a>
</li>
<li class="entry-summary">
<a href="#ignore_macro_hooks%3F%3ABool-instance-method" class="signature"><strong>#ignore_macro_hooks?</strong> : Bool</a>
</li>
<li class="entry-summary">
<a href="#ignore_macros%3D%28ignore_macros%3ABool%29-instance-method" class="signature"><strong>#ignore_macros=</strong>(ignore_macros : Bool)</a>
@ -1212,13 +1228,19 @@ modules, classes, enums, methods and macros.</p>
modules, classes, enums, methods and macros.</p>
<p>YAML configuration example:</p>
<pre><code class="language-crystal"><span class="t">Lint</span><span class="o">/</span><span class="t">Documentation</span>:
<span class="t">Enabled</span>: <span class="n">true</span></code></pre>
<span class="t">Enabled</span>: <span class="n">true</span>
<span class="t">IgnoreClasses</span>: <span class="n">false</span>
<span class="t">IgnoreModules</span>: <span class="n">true</span>
<span class="t">IgnoreEnums</span>: <span class="n">false</span>
<span class="t">IgnoreDefs</span>: <span class="n">true</span>
<span class="t">IgnoreMacros</span>: <span class="n">false</span>
<span class="t">IgnoreMacroHooks</span>: <span class="n">true</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/b4244d4/src/ameba/rule/lint/documentation.cr#L11" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/e1f5c81/src/ameba/rule/lint/documentation.cr#L17" target="_blank">View source</a>]
</div>
</div>
@ -1444,6 +1466,34 @@ modules, classes, enums, methods and macros.</p>
</div>
</div>
<div class="entry-detail" id="ignore_macro_hooks=(ignore_macro_hooks:Bool)-instance-method">
<div class="signature">
def <strong>ignore_macro_hooks=</strong>(ignore_macro_hooks : Bool)
<a class="method-permalink" href="#ignore_macro_hooks%3D%28ignore_macro_hooks%3ABool%29-instance-method">#</a>
</div>
<br/>
<div>
</div>
</div>
<div class="entry-detail" id="ignore_macro_hooks?:Bool-instance-method">
<div class="signature">
def <strong>ignore_macro_hooks?</strong> : Bool
<a class="method-permalink" href="#ignore_macro_hooks%3F%3ABool-instance-method">#</a>
</div>
<br/>
<div>
</div>
</div>
<div class="entry-detail" id="ignore_macros=(ignore_macros:Bool)-instance-method">
<div class="signature">
@ -1539,7 +1589,7 @@ modules, classes, enums, methods and macros.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/b4244d4/src/ameba/rule/lint/documentation.cr#L36" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/e1f5c81/src/ameba/rule/lint/documentation.cr#L43" target="_blank">View source</a>]
</div>
</div>
@ -1555,7 +1605,7 @@ modules, classes, enums, methods and macros.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/b4244d4/src/ameba/rule/lint/documentation.cr#L40" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/e1f5c81/src/ameba/rule/lint/documentation.cr#L47" target="_blank">View source</a>]
</div>
</div>
@ -1571,7 +1621,7 @@ modules, classes, enums, methods and macros.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/b4244d4/src/ameba/rule/lint/documentation.cr#L44" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/e1f5c81/src/ameba/rule/lint/documentation.cr#L51" target="_blank">View source</a>]
</div>
</div>
@ -1587,7 +1637,7 @@ modules, classes, enums, methods and macros.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/b4244d4/src/ameba/rule/lint/documentation.cr#L48" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/e1f5c81/src/ameba/rule/lint/documentation.cr#L55" target="_blank">View source</a>]
</div>
</div>
@ -1603,7 +1653,7 @@ modules, classes, enums, methods and macros.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/b4244d4/src/ameba/rule/lint/documentation.cr#L52" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/e1f5c81/src/ameba/rule/lint/documentation.cr#L59" target="_blank">View source</a>]
</div>
</div>
@ -1619,7 +1669,7 @@ modules, classes, enums, methods and macros.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/b4244d4/src/ameba/rule/lint/documentation.cr#L32" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/e1f5c81/src/ameba/rule/lint/documentation.cr#L39" target="_blank">View source</a>]
</div>
</div>