Skip to content

Commit a479c6a

Browse files
SerafimArtsSerafimArts
committed
Actualize tag docs
1 parent 8401926 commit a479c6a

42 files changed

Lines changed: 506 additions & 367 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/Writerside/tl.tree‎

Lines changed: 40 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -139,57 +139,57 @@
139139
<toc-element topic="version-tag.md" />
140140
</toc-element>
141141
<toc-element toc-title="Psalm" topic="psalm-tags.md">
142-
<toc-element topic="psalm-allow-private-mutation-tag.md" wip="true" />
142+
<toc-element topic="psalm-allow-private-mutation-tag.md" />
143143
<toc-element topic="psalm-api-tag.md" />
144144
<toc-element topic="psalm-assert-tag.md" wip="true" />
145145
<toc-element topic="psalm-assert-if-false-tag.md" wip="true" />
146146
<toc-element topic="psalm-assert-if-true-tag.md" wip="true" />
147147
<toc-element topic="psalm-assert-untainted-tag.md" wip="true" />
148148
<toc-element topic="psalm-check-type-tag.md" wip="true" />
149149
<toc-element topic="psalm-check-type-exact-tag.md" wip="true" />
150-
<toc-element topic="psalm-consistent-constructor-tag.md" wip="true" />
151-
<toc-element topic="psalm-consistent-templates-tag.md" wip="true" />
152-
<toc-element topic="psalm-external-mutation-free-tag.md" wip="true" />
150+
<toc-element topic="psalm-consistent-constructor-tag.md" />
151+
<toc-element topic="psalm-consistent-templates-tag.md" />
152+
<toc-element topic="psalm-external-mutation-free-tag.md" />
153153
<toc-element topic="psalm-extends-tag.md" />
154154
<toc-element topic="psalm-flow-tag.md" wip="true" />
155155
<toc-element topic="psalm-if-this-is-tag.md" wip="true" />
156-
<toc-element topic="psalm-ignore-falsable-return-tag.md" wip="true" />
157-
<toc-element topic="psalm-ignore-nullable-return-tag.md" wip="true" />
158-
<toc-element topic="psalm-ignore-var-tag.md" wip="true" />
159-
<toc-element topic="psalm-ignore-variable-method-tag.md" wip="true" />
160-
<toc-element topic="psalm-ignore-variable-property-tag.md" wip="true" />
156+
<toc-element topic="psalm-ignore-falsable-return-tag.md" />
157+
<toc-element topic="psalm-ignore-nullable-return-tag.md" />
158+
<toc-element topic="psalm-ignore-var-tag.md" />
159+
<toc-element topic="psalm-ignore-variable-method-tag.md" />
160+
<toc-element topic="psalm-ignore-variable-property-tag.md" />
161161
<toc-element topic="psalm-immutable-tag.md" />
162162
<toc-element topic="psalm-implements-tag.md" />
163163
<toc-element topic="psalm-import-type-tag.md" wip="true" />
164164
<toc-element topic="psalm-inheritors-tag.md" wip="true" />
165165
<toc-element topic="psalm-internal-tag.md" />
166166
<toc-element topic="psalm-method-tag.md" />
167-
<toc-element topic="psalm-mutation-free-tag.md" wip="true" />
168-
<toc-element topic="psalm-no-seal-methods-tag.md" wip="true" />
169-
<toc-element topic="psalm-no-seal-properties-tag.md" wip="true" />
170-
<toc-element topic="psalm-override-method-visibility-tag.md" wip="true" />
171-
<toc-element topic="psalm-override-property-visibility-tag.md" wip="true" />
167+
<toc-element topic="psalm-mutation-free-tag.md" />
168+
<toc-element topic="psalm-no-seal-methods-tag.md" />
169+
<toc-element topic="psalm-no-seal-properties-tag.md" />
170+
<toc-element topic="psalm-override-method-visibility-tag.md" />
171+
<toc-element topic="psalm-override-property-visibility-tag.md" />
172172
<toc-element topic="psalm-param-tag.md" />
173173
<toc-element topic="psalm-param-out-tag.md" />
174174
<toc-element topic="psalm-property-tag.md" />
175175
<toc-element topic="psalm-property-read-tag.md" />
176176
<toc-element topic="psalm-property-write-tag.md" />
177-
<toc-element topic="psalm-pure-tag.md" wip="true" />
177+
<toc-element topic="psalm-pure-tag.md" />
178178
<toc-element topic="psalm-readonly-tag.md" />
179-
<toc-element topic="psalm-readonly-allow-private-mutation-tag.md" wip="true" />
179+
<toc-element topic="psalm-readonly-allow-private-mutation-tag.md" />
180180
<toc-element topic="psalm-require-extends-tag.md" />
181181
<toc-element topic="psalm-require-implements-tag.md" />
182182
<toc-element topic="psalm-return-tag.md" />
183183
<toc-element topic="psalm-scope-this-tag.md" wip="true" />
184184
<toc-element topic="psalm-seal-methods-tag.md" />
185185
<toc-element topic="psalm-seal-properties-tag.md" />
186186
<toc-element topic="psalm-self-out-tag.md" wip="true" />
187-
<toc-element topic="psalm-stub-override-tag.md" wip="true" />
187+
<toc-element topic="psalm-stub-override-tag.md" />
188188
<toc-element topic="psalm-suppress-tag.md" />
189189
<toc-element topic="psalm-taint-escape-tag.md" wip="true" />
190190
<toc-element topic="psalm-taint-sink-tag.md" wip="true" />
191191
<toc-element topic="psalm-taint-source-tag.md" wip="true" />
192-
<toc-element topic="psalm-taint-specialize-tag.md" wip="true" />
192+
<toc-element topic="psalm-taint-specialize-tag.md" />
193193
<toc-element topic="psalm-taint-unescape-tag.md" wip="true" />
194194
<toc-element topic="psalm-template-tag.md" />
195195
<toc-element topic="psalm-template-contravariant-tag.md" />
@@ -199,23 +199,23 @@
199199
<toc-element topic="psalm-type-tag.md" wip="true" />
200200
<toc-element topic="psalm-use-tag.md" />
201201
<toc-element topic="psalm-var-tag.md" />
202-
<toc-element topic="psalm-variadic-tag.md" wip="true" />
202+
<toc-element topic="psalm-variadic-tag.md" />
203203
<toc-element topic="psalm-yield-tag.md" wip="true" />
204204
</toc-element>
205205
<toc-element toc-title="PHPStan" topic="phpstan-tags.md">
206-
<toc-element topic="phpstan-allow-private-mutation-tag.md" wip="true" />
206+
<toc-element topic="phpstan-allow-private-mutation-tag.md" />
207207
<toc-element topic="phpstan-assert-tag.md" wip="true" />
208208
<toc-element topic="phpstan-assert-if-false-tag.md" wip="true" />
209209
<toc-element topic="phpstan-assert-if-true-tag.md" wip="true" />
210-
<toc-element topic="phpstan-consistent-constructor-tag.md" wip="true" />
210+
<toc-element topic="phpstan-consistent-constructor-tag.md" />
211211
<toc-element topic="phpstan-extends-tag.md" />
212212
<toc-element topic="phpstan-ignore-tag.md" wip="true" />
213-
<toc-element topic="phpstan-ignore-line-tag.md" wip="true" />
214-
<toc-element topic="phpstan-ignore-next-line-tag.md" wip="true" />
213+
<toc-element topic="phpstan-ignore-line-tag.md" />
214+
<toc-element topic="phpstan-ignore-next-line-tag.md" />
215215
<toc-element topic="phpstan-immutable-tag.md" />
216216
<toc-element topic="phpstan-implements-tag.md" />
217217
<toc-element topic="phpstan-import-type-tag.md" wip="true" />
218-
<toc-element topic="phpstan-impure-tag.md" wip="true" />
218+
<toc-element topic="phpstan-impure-tag.md" />
219219
<toc-element topic="phpstan-method-tag.md" />
220220
<toc-element topic="phpstan-param-tag.md" />
221221
<toc-element topic="phpstan-param-closure-this-tag.md" />
@@ -225,10 +225,10 @@
225225
<toc-element topic="phpstan-property-tag.md" />
226226
<toc-element topic="phpstan-property-read-tag.md" />
227227
<toc-element topic="phpstan-property-write-tag.md" />
228-
<toc-element topic="phpstan-pure-tag.md" wip="true" />
228+
<toc-element topic="phpstan-pure-tag.md" />
229229
<toc-element topic="phpstan-pure-unless-callable-is-impure-tag.md" />
230230
<toc-element topic="phpstan-readonly-tag.md" />
231-
<toc-element topic="phpstan-readonly-allow-private-mutation-tag.md" wip="true" />
231+
<toc-element topic="phpstan-readonly-allow-private-mutation-tag.md" />
232232
<toc-element topic="phpstan-require-extends-tag.md" />
233233
<toc-element topic="phpstan-require-implements-tag.md" />
234234
<toc-element topic="phpstan-return-tag.md" />
@@ -251,52 +251,52 @@
251251
<toc-element topic="phan-assert-if-true-tag.md" wip="true" />
252252
<toc-element topic="phan-assert-true-condition-tag.md" wip="true" />
253253
<toc-element topic="phan-closure-scope-tag.md" wip="true" />
254-
<toc-element topic="phan-constructor-used-for-side-effects-tag.md" wip="true" />
254+
<toc-element topic="phan-constructor-used-for-side-effects-tag.md" />
255255
<toc-element topic="phan-extends-tag.md" />
256256
<toc-element topic="phan-file-suppress-tag.md" wip="true" />
257-
<toc-element topic="phan-forbid-undeclared-magic-methods-tag.md" wip="true" />
258-
<toc-element topic="phan-forbid-undeclared-magic-properties-tag.md" wip="true" />
257+
<toc-element topic="phan-forbid-undeclared-magic-methods-tag.md" />
258+
<toc-element topic="phan-forbid-undeclared-magic-properties-tag.md" />
259259
<toc-element topic="phan-hardcode-return-type-tag.md" wip="true" />
260260
<toc-element topic="phan-immutable-tag.md" />
261261
<toc-element topic="phan-inherits-tag.md" />
262262
<toc-element topic="phan-method-tag.md" />
263263
<toc-element topic="phan-mixin-tag.md" />
264-
<toc-element topic="phan-output-reference-tag.md" wip="true" />
264+
<toc-element topic="phan-output-reference-tag.md" />
265265
<toc-element topic="phan-override-tag.md" />
266266
<toc-element topic="phan-param-tag.md" />
267267
<toc-element topic="phan-property-tag.md" />
268268
<toc-element topic="phan-property-read-tag.md" />
269269
<toc-element topic="phan-property-write-tag.md" />
270-
<toc-element topic="phan-pure-tag.md" wip="true" />
270+
<toc-element topic="phan-pure-tag.md" />
271271
<toc-element topic="phan-read-only-tag.md" />
272272
<toc-element topic="phan-real-return-tag.md" wip="true" />
273273
<toc-element topic="phan-return-tag.md" />
274-
<toc-element topic="phan-side-effect-free-tag.md" wip="true" />
274+
<toc-element topic="phan-side-effect-free-tag.md" />
275275
<toc-element topic="phan-suppress-current-line-tag.md" wip="true" />
276276
<toc-element topic="phan-suppress-next-line-tag.md" wip="true" />
277277
<toc-element topic="phan-suppress-next-next-line-tag.md" wip="true" />
278278
<toc-element topic="phan-suppress-previous-line-tag.md" wip="true" />
279279
<toc-element topic="phan-template-tag.md" />
280-
<toc-element topic="phan-transient-tag.md" wip="true" />
280+
<toc-element topic="phan-transient-tag.md" />
281281
<toc-element topic="phan-type-tag.md" wip="true" />
282282
<toc-element topic="phan-unused-param-tag.md" />
283283
<toc-element topic="phan-var-tag.md" />
284-
<toc-element topic="phan-write-only-tag.md" wip="true" />
284+
<toc-element topic="phan-write-only-tag.md" />
285285
<toc-element topic="phanclosurescope-tag.md" wip="true" />
286286
</toc-element>
287287
<toc-element toc-title="PhpStorm" topic="phpstorm-tags.md">
288288
<toc-element topic="noinspection-tag.md" wip="true" />
289289
<toc-element topic="language-tag.md" wip="true" />
290290
<toc-element topic="expected-exception-tag.md" wip="true" />
291-
<toc-element topic="formatter-off-tag.md" wip="true" />
292-
<toc-element topic="formatter-on-tag.md" wip="true" />
291+
<toc-element topic="formatter-off-tag.md" />
292+
<toc-element topic="formatter-on-tag.md" />
293293
</toc-element>
294294
<toc-element toc-title="PHP CodeSniffer" topic="phpcs-tags.md">
295295
<toc-element topic="phpcs-suppress-tag.md" wip="true" />
296-
<toc-element topic="coding-standards-ignore-start-tag.md" wip="true" />
297-
<toc-element topic="coding-standards-ignore-end-tag.md" wip="true" />
298-
<toc-element topic="coding-standards-ignore-line-tag.md" wip="true" />
299-
<toc-element topic="coding-standards-ignore-file-tag.md" wip="true" />
296+
<toc-element topic="coding-standards-ignore-start-tag.md" />
297+
<toc-element topic="coding-standards-ignore-end-tag.md" />
298+
<toc-element topic="coding-standards-ignore-line-tag.md" />
299+
<toc-element topic="coding-standards-ignore-file-tag.md" />
300300
<toc-element topic="coding-standards-tag.md" wip="true" />
301301
</toc-element>
302302
<toc-element topic="custom-tags.md" toc-title="Custom Tags">

‎docs/Writerside/topics/phpdoc/tags/coding-standards-ignore-end-tag.md‎

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,23 @@
11
# @codingStandardsIgnoreEnd
22

33
<primary-label ref="phpdoc-component"/>
4-
<secondary-label ref="not-implemented"/>
54

65
The `@codingStandardsIgnoreEnd` tag ends a block of code started by
76
[@codingStandardsIgnoreStart](coding-standards-ignore-start-tag.md),
87
resuming coding-standard checks from this point on. This is pre-3.2.0
98
PHP_CodeSniffer syntax; current PHP_CodeSniffer prefers the `phpcs:*`
109
comment syntax instead, but still understands it.
1110

12-
<note>
13-
Not yet recognized by <code>TypeLang\PhpDoc\DocBlockParser</code> — parsing
14-
a docblock containing this tag returns a plain <code>Tag</code>, its whole
15-
suffix folded into the description. See
16-
<a href="custom-tags.md">Custom Tags</a> for the current workaround if you
17-
need to recognize it yourself.
18-
</note>
11+
```
12+
"@codingStandardsIgnoreEnd" [ <Description> ]
13+
```
14+
15+
Parsing a `@codingStandardsIgnoreEnd` tag produces a `CodingStandardsIgnoreEndTag` instance. Being a pure
16+
marker, it adds nothing beyond the `$name` and optional `$description`
17+
every [Tag](phpdoc.md#tag) already carries.
18+
19+
```php
20+
final class CodingStandardsIgnoreEndTag extends FlagTag {}
21+
```
1922

2023
Defined by [PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer/wiki/Advanced-Usage#ignoring-parts-of-a-file).

‎docs/Writerside/topics/phpdoc/tags/coding-standards-ignore-file-tag.md‎

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,22 @@
11
# @codingStandardsIgnoreFile
22

33
<primary-label ref="phpdoc-component"/>
4-
<secondary-label ref="not-implemented"/>
54

65
The `@codingStandardsIgnoreFile` tag ignores the whole file for
76
coding-standard checks. This is pre-3.2.0 PHP_CodeSniffer syntax; current
87
PHP_CodeSniffer prefers the `phpcs:*` comment syntax instead, but still
98
understands it.
109

11-
<note>
12-
Not yet recognized by <code>TypeLang\PhpDoc\DocBlockParser</code> — parsing
13-
a docblock containing this tag returns a plain <code>Tag</code>, its whole
14-
suffix folded into the description. See
15-
<a href="custom-tags.md">Custom Tags</a> for the current workaround if you
16-
need to recognize it yourself.
17-
</note>
10+
```
11+
"@codingStandardsIgnoreFile" [ <Description> ]
12+
```
13+
14+
Parsing a `@codingStandardsIgnoreFile` tag produces a `CodingStandardsIgnoreFileTag` instance. Being a pure
15+
marker, it adds nothing beyond the `$name` and optional `$description`
16+
every [Tag](phpdoc.md#tag) already carries.
17+
18+
```php
19+
final class CodingStandardsIgnoreFileTag extends FlagTag {}
20+
```
1821

1922
Defined by [PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer/wiki/Advanced-Usage#ignoring-files-and-folders).

‎docs/Writerside/topics/phpdoc/tags/coding-standards-ignore-line-tag.md‎

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# @codingStandardsIgnoreLine
22

33
<primary-label ref="phpdoc-component"/>
4-
<secondary-label ref="not-implemented"/>
54

65
The `@codingStandardsIgnoreLine` tag ignores a single line of code for
76
coding-standard checks, without needing a paired
@@ -10,12 +9,16 @@ coding-standard checks, without needing a paired
109
This is pre-3.2.0 PHP_CodeSniffer syntax; current PHP_CodeSniffer prefers
1110
the `phpcs:*` comment syntax instead, but still understands it.
1211

13-
<note>
14-
Not yet recognized by <code>TypeLang\PhpDoc\DocBlockParser</code> — parsing
15-
a docblock containing this tag returns a plain <code>Tag</code>, its whole
16-
suffix folded into the description. See
17-
<a href="custom-tags.md">Custom Tags</a> for the current workaround if you
18-
need to recognize it yourself.
19-
</note>
12+
```
13+
"@codingStandardsIgnoreLine" [ <Description> ]
14+
```
15+
16+
Parsing a `@codingStandardsIgnoreLine` tag produces a `CodingStandardsIgnoreLineTag` instance. Being a pure
17+
marker, it adds nothing beyond the `$name` and optional `$description`
18+
every [Tag](phpdoc.md#tag) already carries.
19+
20+
```php
21+
final class CodingStandardsIgnoreLineTag extends FlagTag {}
22+
```
2023

2124
Defined by [PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer/wiki/Advanced-Usage#ignoring-parts-of-a-file).

‎docs/Writerside/topics/phpdoc/tags/coding-standards-ignore-start-tag.md‎

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,23 @@
11
# @codingStandardsIgnoreStart
22

33
<primary-label ref="phpdoc-component"/>
4-
<secondary-label ref="not-implemented"/>
54

65
The `@codingStandardsIgnoreStart` tag starts a block of code excluded
76
from coding-standard checks, closed by a matching
87
[@codingStandardsIgnoreEnd](coding-standards-ignore-end-tag.md). This is
98
pre-3.2.0 PHP_CodeSniffer syntax; current PHP_CodeSniffer prefers the
109
`phpcs:*` comment syntax instead, but still understands it.
1110

12-
<note>
13-
Not yet recognized by <code>TypeLang\PhpDoc\DocBlockParser</code> — parsing
14-
a docblock containing this tag returns a plain <code>Tag</code>, its whole
15-
suffix folded into the description. See
16-
<a href="custom-tags.md">Custom Tags</a> for the current workaround if you
17-
need to recognize it yourself.
18-
</note>
11+
```
12+
"@codingStandardsIgnoreStart" [ <Description> ]
13+
```
14+
15+
Parsing a `@codingStandardsIgnoreStart` tag produces a `CodingStandardsIgnoreStartTag` instance. Being a pure
16+
marker, it adds nothing beyond the `$name` and optional `$description`
17+
every [Tag](phpdoc.md#tag) already carries.
18+
19+
```php
20+
final class CodingStandardsIgnoreStartTag extends FlagTag {}
21+
```
1922

2023
Defined by [PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer/wiki/Advanced-Usage#ignoring-parts-of-a-file).

‎docs/Writerside/topics/phpdoc/tags/formatter-off-tag.md‎

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,21 @@
11
# @formatter:off
22

33
<primary-label ref="phpdoc-component"/>
4-
<secondary-label ref="not-implemented"/>
54

65
The `@formatter:off` tag disables PhpStorm's automatic code formatting
76
from this point on, until a matching
87
[@formatter:on](formatter-on-tag.md) is found further down the file.
98

109
```
11-
"@formatter:off"
10+
"@formatter:off" [ <Description> ]
1211
```
1312

14-
<note>
15-
Not yet recognized by <code>TypeLang\PhpDoc\DocBlockParser</code> — parsing
16-
a docblock containing this tag returns a plain <code>Tag</code>, its whole
17-
suffix folded into the description. See
18-
<a href="custom-tags.md">Custom Tags</a> for the current workaround if you
19-
need to recognize it yourself.
20-
</note>
13+
Parsing a `@formatter:off` tag produces a `FormatterOffTag` instance. Being a pure
14+
marker, it adds nothing beyond the `$name` and optional `$description`
15+
every [Tag](phpdoc.md#tag) already carries.
16+
17+
```php
18+
final class FormatterOffTag extends FlagTag {}
19+
```
2120

2221
Associated with PhpStorm.

‎docs/Writerside/topics/phpdoc/tags/formatter-on-tag.md‎

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,21 @@
11
# @formatter:on
22

33
<primary-label ref="phpdoc-component"/>
4-
<secondary-label ref="not-implemented"/>
54

65
The `@formatter:on` tag re-enables PhpStorm's automatic code formatting
76
from this point on, pairing with an earlier
87
[@formatter:off](formatter-off-tag.md).
98

109
```
11-
"@formatter:on"
10+
"@formatter:on" [ <Description> ]
1211
```
1312

14-
<note>
15-
Not yet recognized by <code>TypeLang\PhpDoc\DocBlockParser</code> — parsing
16-
a docblock containing this tag returns a plain <code>Tag</code>, its whole
17-
suffix folded into the description. See
18-
<a href="custom-tags.md">Custom Tags</a> for the current workaround if you
19-
need to recognize it yourself.
20-
</note>
13+
Parsing a `@formatter:on` tag produces a `FormatterOnTag` instance. Being a pure
14+
marker, it adds nothing beyond the `$name` and optional `$description`
15+
every [Tag](phpdoc.md#tag) already carries.
16+
17+
```php
18+
final class FormatterOnTag extends FlagTag {}
19+
```
2120

2221
Associated with PhpStorm.

0 commit comments

Comments
 (0)