Skip to content

Commit b97413b

Browse files
committed
Docs website: regenerate the phpDocs
Regeneration after various reported bugs have been fixed. The docs have been regenerated based on phpDocumentor `master` with `--visibility=public,protected`.
1 parent 7a54196 commit b97413b

26 files changed

+775
-333
lines changed

docs/phpdoc/classes/PHPCSUtils-AbstractSniffs-AbstractArrayDeclarationSniff.html

Lines changed: 57 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -120,92 +120,128 @@ <h3>Table of Contents</h3>
120120
<dl class="phpdocumentor-table-of-contents">
121121
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
122122
<a href="../classes/PHPCSUtils-AbstractSniffs-AbstractArrayDeclarationSniff.html#property_stackPtr">$stackPtr</a>
123-
: int </dt>
123+
<span>
124+
&nbsp;: int </span>
125+
</dt>
124126
<dd>The stack pointer to the array keyword or the short array open token.</dd>
125127

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

211247
</dl>
@@ -430,7 +466,7 @@ <h4 class="phpdocumentor-element__name">$itemCount</h4>
430466
<span class="phpdocumentor-signature__visibility">protected</span>
431467
<span class="phpdocumentor-signature__type">int</span>
432468
<span class="phpdocumentor-signature__name">$itemCount</span>
433-
= <span class="phpdocumentor-signature__default-value">""</span></code>
469+
= <span class="phpdocumentor-signature__default-value">0</span></code>
434470

435471

436472

@@ -842,7 +878,7 @@ <h5 class="phpdocumentor-tag-list__heading">Tags</h5>
842878
<span class="phpdocumentor-tag__name">see</span>
843879
</dt>
844880
<dd class="phpdocumentor-tag-list__definition">
845-
<span class="phpdocumentor-tag-link"><a href="\PHPCSUtils\AbstractSniffs\AbstractArrayDeclarationSniff::getActualArrayKey()"><abbr title="\PHPCSUtils\AbstractSniffs\AbstractArrayDeclarationSniff::getActualArrayKey()">AbstractArrayDeclarationSniff::getActualArrayKey()</abbr></a></span>
881+
<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>
846882
<section class="phpdocumentor-description"><p>Optional helper function.</p></section>
847883
</dd>
848884
</dl>
@@ -921,7 +957,7 @@ <h5 class="phpdocumentor-tag-list__heading">Tags</h5>
921957
<span class="phpdocumentor-tag__name">see</span>
922958
</dt>
923959
<dd class="phpdocumentor-tag-list__definition">
924-
<span class="phpdocumentor-tag-link"><a href="\PHPCSUtils\AbstractSniffs\AbstractArrayDeclarationSniff::processValue()"><abbr title="\PHPCSUtils\AbstractSniffs\AbstractArrayDeclarationSniff::processValue()">AbstractArrayDeclarationSniff::processValue()</abbr></a></span>
960+
<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>
925961
<section class="phpdocumentor-description"><p>Method to process the array value.</p></section>
926962
</dd>
927963
</dl>

0 commit comments

Comments
 (0)