Skip to content

Commit

Permalink
Docs website: regenerate the phpDocs
Browse files Browse the repository at this point in the history
Regeneration after various reported bugs have been fixed.

The docs have been regenerated based on phpDocumentor `master` with `--visibility=public,protected`.
  • Loading branch information
jrfnl committed Jun 17, 2020
1 parent 7a54196 commit b97413b
Show file tree
Hide file tree
Showing 26 changed files with 775 additions and 333 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -120,92 +120,128 @@ <h3>Table of Contents</h3>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a href="../classes/PHPCSUtils-AbstractSniffs-AbstractArrayDeclarationSniff.html#property_stackPtr">$stackPtr</a>
: int </dt>
<span>
&nbsp;: int </span>
</dt>
<dd>The stack pointer to the array keyword or the short array open token.</dd>

<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a href="../classes/PHPCSUtils-AbstractSniffs-AbstractArrayDeclarationSniff.html#property_tokens">$tokens</a>
: array </dt>
<span>
&nbsp;: array </span>
</dt>
<dd>The token stack for the current file being examined.</dd>

<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a href="../classes/PHPCSUtils-AbstractSniffs-AbstractArrayDeclarationSniff.html#property_arrayOpener">$arrayOpener</a>
: int </dt>
<span>
&nbsp;: int </span>
</dt>
<dd>The stack pointer to the array opener.</dd>

<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a href="../classes/PHPCSUtils-AbstractSniffs-AbstractArrayDeclarationSniff.html#property_arrayCloser">$arrayCloser</a>
: int </dt>
<span>
&nbsp;: int </span>
</dt>
<dd>The stack pointer to the array closer.</dd>

<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a href="../classes/PHPCSUtils-AbstractSniffs-AbstractArrayDeclarationSniff.html#property_arrayItems">$arrayItems</a>
: array </dt>
<span>
&nbsp;: array </span>
</dt>
<dd>A multi-dimentional array with information on each array item.</dd>

<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a href="../classes/PHPCSUtils-AbstractSniffs-AbstractArrayDeclarationSniff.html#property_itemCount">$itemCount</a>
: int </dt>
<span>
&nbsp;: int </span>
</dt>
<dd>How many items are in the array.</dd>

<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a href="../classes/PHPCSUtils-AbstractSniffs-AbstractArrayDeclarationSniff.html#property_singleLine">$singleLine</a>
: bool </dt>
<span>
&nbsp;: bool </span>
</dt>
<dd>Whether or not the array is single line.</dd>

<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="../classes/PHPCSUtils-AbstractSniffs-AbstractArrayDeclarationSniff.html#method___construct">__construct()</a>
: void</dt>
<span>
&nbsp;: void </span>
</dt>
<dd>Set up this class.</dd>

<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="../classes/PHPCSUtils-AbstractSniffs-AbstractArrayDeclarationSniff.html#method_register">register()</a>
: array</dt>
<span>
&nbsp;: array </span>
</dt>
<dd>Returns an array of tokens this test wants to listen for.</dd>

<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="../classes/PHPCSUtils-AbstractSniffs-AbstractArrayDeclarationSniff.html#method_process">process()</a>
: void</dt>
<span>
&nbsp;: void </span>
</dt>
<dd>Processes this test when one of its tokens is encountered.</dd>

<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="../classes/PHPCSUtils-AbstractSniffs-AbstractArrayDeclarationSniff.html#method_processArray">processArray()</a>
: void</dt>
<span>
&nbsp;: void </span>
</dt>
<dd>Process every part of the array declaration.</dd>

<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="../classes/PHPCSUtils-AbstractSniffs-AbstractArrayDeclarationSniff.html#method_processOpenClose">processOpenClose()</a>
: bool|void</dt>
<span>
&nbsp;: bool|void </span>
</dt>
<dd>Process the array opener and closer.</dd>

<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="../classes/PHPCSUtils-AbstractSniffs-AbstractArrayDeclarationSniff.html#method_processKey">processKey()</a>
: bool|void</dt>
<span>
&nbsp;: bool|void </span>
</dt>
<dd>Process the tokens in an array key.</dd>

<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="../classes/PHPCSUtils-AbstractSniffs-AbstractArrayDeclarationSniff.html#method_processNoKey">processNoKey()</a>
: bool|void</dt>
<span>
&nbsp;: bool|void </span>
</dt>
<dd>Process an array item without an array key.</dd>

<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="../classes/PHPCSUtils-AbstractSniffs-AbstractArrayDeclarationSniff.html#method_processArrow">processArrow()</a>
: bool|void</dt>
<span>
&nbsp;: bool|void </span>
</dt>
<dd>Process the double arrow.</dd>

<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="../classes/PHPCSUtils-AbstractSniffs-AbstractArrayDeclarationSniff.html#method_processValue">processValue()</a>
: bool|void</dt>
<span>
&nbsp;: bool|void </span>
</dt>
<dd>Process the tokens in an array value.</dd>

<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="../classes/PHPCSUtils-AbstractSniffs-AbstractArrayDeclarationSniff.html#method_processComma">processComma()</a>
: bool|void</dt>
<span>
&nbsp;: bool|void </span>
</dt>
<dd>Process the comma after an array item.</dd>

<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="../classes/PHPCSUtils-AbstractSniffs-AbstractArrayDeclarationSniff.html#method_getActualArrayKey">getActualArrayKey()</a>
: string|int|void</dt>
<span>
&nbsp;: string|int|void </span>
</dt>
<dd>Determine what the actual array key would be.</dd>

</dl>
Expand Down Expand Up @@ -430,7 +466,7 @@ <h4 class="phpdocumentor-element__name">$itemCount</h4>
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__type">int</span>
<span class="phpdocumentor-signature__name">$itemCount</span>
= <span class="phpdocumentor-signature__default-value">""</span></code>
= <span class="phpdocumentor-signature__default-value">0</span></code>



Expand Down Expand Up @@ -842,7 +878,7 @@ <h5 class="phpdocumentor-tag-list__heading">Tags</h5>
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="\PHPCSUtils\AbstractSniffs\AbstractArrayDeclarationSniff::getActualArrayKey()"><abbr title="\PHPCSUtils\AbstractSniffs\AbstractArrayDeclarationSniff::getActualArrayKey()">AbstractArrayDeclarationSniff::getActualArrayKey()</abbr></a></span>
<span class="phpdocumentor-tag-link"><a href="../classes/PHPCSUtils-AbstractSniffs-AbstractArrayDeclarationSniff.html#method_getActualArrayKey"><abbr title="\PHPCSUtils\AbstractSniffs\AbstractArrayDeclarationSniff::getActualArrayKey()">AbstractArrayDeclarationSniff::getActualArrayKey()</abbr></a></span>
<section class="phpdocumentor-description"><p>Optional helper function.</p></section>
</dd>
</dl>
Expand Down Expand Up @@ -921,7 +957,7 @@ <h5 class="phpdocumentor-tag-list__heading">Tags</h5>
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="\PHPCSUtils\AbstractSniffs\AbstractArrayDeclarationSniff::processValue()"><abbr title="\PHPCSUtils\AbstractSniffs\AbstractArrayDeclarationSniff::processValue()">AbstractArrayDeclarationSniff::processValue()</abbr></a></span>
<span class="phpdocumentor-tag-link"><a href="../classes/PHPCSUtils-AbstractSniffs-AbstractArrayDeclarationSniff.html#method_processValue"><abbr title="\PHPCSUtils\AbstractSniffs\AbstractArrayDeclarationSniff::processValue()">AbstractArrayDeclarationSniff::processValue()</abbr></a></span>
<section class="phpdocumentor-description"><p>Method to process the array value.</p></section>
</dd>
</dl>
Expand Down
Loading

0 comments on commit b97413b

Please sign in to comment.