Skip to content

Commit 94ed284

Browse files
committed
Fix documentation tag links
1 parent 1201077 commit 94ed284

3 files changed

Lines changed: 74 additions & 38 deletions

File tree

β€ŽWriterside/topics/phpdoc/phan-tags.mdβ€Ž

Lines changed: 28 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -17,23 +17,35 @@ one Phan should trust.
1717

1818
## What This Group Covers
1919

20-
* **Assertions** β€” `@phan-assert`, `@phan-assert-true-condition`,
21-
`@phan-assert-false-condition`, `@phan-assert-if-true`,
22-
`@phan-assert-if-false`.
23-
* **Line-scoped suppression** β€” `@phan-suppress-current-line`,
24-
`@phan-suppress-next-line`, `@phan-suppress-next-next-line`,
25-
`@phan-suppress-previous-line`, and the file-wide `@phan-file-suppress`.
26-
* **Return types** β€” `@phan-real-return`, `@phan-hardcode-return-type`,
20+
* **Assertions** β€” [@phan-assert](phan-assert-tag.md),
21+
[@phan-assert-true-condition](phan-assert-true-condition-tag.md),
22+
[@phan-assert-false-condition](phan-assert-false-condition-tag.md),
23+
[@phan-assert-if-true](phan-assert-if-true-tag.md),
24+
[@phan-assert-if-false](phan-assert-if-false-tag.md).
25+
* **Line-scoped suppression** β€”
26+
[@phan-suppress-current-line](phan-suppress-current-line-tag.md),
27+
[@phan-suppress-next-line](phan-suppress-next-line-tag.md),
28+
[@phan-suppress-next-next-line](phan-suppress-next-next-line-tag.md),
29+
[@phan-suppress-previous-line](phan-suppress-previous-line-tag.md), and the
30+
file-wide [@phan-file-suppress](phan-file-suppress-tag.md).
31+
* **Return types** β€” [@phan-real-return](phan-real-return-tag.md),
32+
[@phan-hardcode-return-type](phan-hardcode-return-type-tag.md),
2733
distinguishing the type Phan should infer from the one it should report.
28-
* **Magic-member policy** β€” `@phan-forbid-undeclared-magic-methods`,
29-
`@phan-forbid-undeclared-magic-properties`,
30-
`@phan-read-only`, `@phan-write-only`.
31-
* **Purity and immutability** β€” `@phan-pure`, `@phan-side-effect-free`,
32-
`@phan-immutable`, `@phan-constructor-used-for-side-effects`.
33-
* **Prefixed overrides** β€” `@phan-var`, `@phan-param`, `@phan-return`,
34-
`@phan-property`, `@phan-method`, `@phan-template`, `@phan-mixin`,
35-
`@phan-extends`, and the rest, each shadowing its unprefixed counterpart
36-
for Phan specifically.
34+
* **Magic-member policy** β€”
35+
[@phan-forbid-undeclared-magic-methods](phan-forbid-undeclared-magic-methods-tag.md),
36+
[@phan-forbid-undeclared-magic-properties](phan-forbid-undeclared-magic-properties-tag.md),
37+
[@phan-read-only](phan-read-only-tag.md),
38+
[@phan-write-only](phan-write-only-tag.md).
39+
* **Purity and immutability** β€” [@phan-pure](phan-pure-tag.md),
40+
[@phan-side-effect-free](phan-side-effect-free-tag.md),
41+
[@phan-immutable](phan-immutable-tag.md),
42+
[@phan-constructor-used-for-side-effects](phan-constructor-used-for-side-effects-tag.md).
43+
* **Prefixed overrides** β€” [@phan-var](phan-var-tag.md),
44+
[@phan-param](phan-param-tag.md), [@phan-return](phan-return-tag.md),
45+
[@phan-property](phan-property-tag.md),
46+
[@phan-method](phan-method-tag.md), [@phan-template](phan-template-tag.md),
47+
[@phan-mixin](phan-mixin-tag.md), [@phan-extends](phan-extends-tag.md), and
48+
the rest, each shadowing its unprefixed counterpart for Phan specifically.
3749

3850
<note>
3951
Nearly every tag in this group is recognized once the <b>Phan</b> platform is

β€ŽWriterside/topics/phpdoc/phpstan-tags.mdβ€Ž

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -19,18 +19,30 @@ disagree.
1919

2020
## What This Group Covers
2121

22-
* **Assertions** β€” `@phpstan-assert`, `@phpstan-assert-if-true`,
23-
`@phpstan-assert-if-false`.
22+
* **Assertions** β€” [@phpstan-assert](phpstan-assert-tag.md),
23+
[@phpstan-assert-if-true](phpstan-assert-if-true-tag.md),
24+
[@phpstan-assert-if-false](phpstan-assert-if-false-tag.md).
2425
* **Diagnostic suppression** β€” the `@phpstan-ignore` family
25-
(`@phpstan-ignore`, `@phpstan-ignore-line`, `@phpstan-ignore-next-line`).
26-
* **Purity and immutability** β€” `@phpstan-pure`, `@phpstan-impure`,
27-
`@phpstan-immutable`, `@phpstan-readonly`,
28-
`@phpstan-pure-unless-callable-is-impure`.
29-
* **Type aliases and generics** β€” `@phpstan-type`, `@phpstan-import-type`,
30-
`@phpstan-template` (with its covariant and contravariant forms).
31-
* **Prefixed overrides** β€” `@phpstan-param`, `@phpstan-return`,
32-
`@phpstan-var`, `@phpstan-property`, `@phpstan-method`,
33-
`@phpstan-param-out`, `@phpstan-self-out`, and the rest, each shadowing
26+
([@phpstan-ignore](phpstan-ignore-tag.md),
27+
[@phpstan-ignore-line](phpstan-ignore-line-tag.md),
28+
[@phpstan-ignore-next-line](phpstan-ignore-next-line-tag.md)).
29+
* **Purity and immutability** β€” [@phpstan-pure](phpstan-pure-tag.md),
30+
[@phpstan-impure](phpstan-impure-tag.md),
31+
[@phpstan-immutable](phpstan-immutable-tag.md),
32+
[@phpstan-readonly](phpstan-readonly-tag.md),
33+
[@phpstan-pure-unless-callable-is-impure](phpstan-pure-unless-callable-is-impure-tag.md).
34+
* **Type aliases and generics** β€” [@phpstan-type](phpstan-type-tag.md),
35+
[@phpstan-import-type](phpstan-import-type-tag.md),
36+
[@phpstan-template](phpstan-template-tag.md) (with its
37+
[covariant](phpstan-template-covariant-tag.md) and
38+
[contravariant](phpstan-template-contravariant-tag.md) forms).
39+
* **Prefixed overrides** β€” [@phpstan-param](phpstan-param-tag.md),
40+
[@phpstan-return](phpstan-return-tag.md),
41+
[@phpstan-var](phpstan-var-tag.md),
42+
[@phpstan-property](phpstan-property-tag.md),
43+
[@phpstan-method](phpstan-method-tag.md),
44+
[@phpstan-param-out](phpstan-param-out-tag.md),
45+
[@phpstan-self-out](phpstan-self-out-tag.md), and the rest, each shadowing
3446
its unprefixed counterpart for PHPStan specifically.
3547

3648
<note>

β€ŽWriterside/topics/phpdoc/psalm-tags.mdβ€Ž

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -21,17 +21,29 @@ Psalm is the analyzer reading it."
2121

2222
The tags here span Psalm's full feature surface, including:
2323

24-
* **Assertions** β€” `@psalm-assert`, `@psalm-assert-if-true`,
25-
`@psalm-assert-if-false`, `@psalm-assert-untainted`.
26-
* **Immutability and purity** β€” `@psalm-immutable`, `@psalm-pure`,
27-
`@psalm-mutation-free`, `@psalm-external-mutation-free`,
28-
`@psalm-readonly`.
29-
* **Taint analysis** β€” `@psalm-taint-source`, `@psalm-taint-sink`,
30-
`@psalm-taint-escape`, `@psalm-taint-specialize`, and related flow tags.
31-
* **Type aliases and generics** β€” `@psalm-type`, `@psalm-import-type`,
32-
`@psalm-template` (with its covariant and contravariant forms).
33-
* **Prefixed overrides** β€” `@psalm-param`, `@psalm-return`, `@psalm-var`,
34-
`@psalm-property`, `@psalm-method`, and the rest, each shadowing its
24+
* **Assertions** β€” [@psalm-assert](psalm-assert-tag.md),
25+
[@psalm-assert-if-true](psalm-assert-if-true-tag.md),
26+
[@psalm-assert-if-false](psalm-assert-if-false-tag.md),
27+
[@psalm-assert-untainted](psalm-assert-untainted-tag.md).
28+
* **Immutability and purity** β€” [@psalm-immutable](psalm-immutable-tag.md),
29+
[@psalm-pure](psalm-pure-tag.md),
30+
[@psalm-mutation-free](psalm-mutation-free-tag.md),
31+
[@psalm-external-mutation-free](psalm-external-mutation-free-tag.md),
32+
[@psalm-readonly](psalm-readonly-tag.md).
33+
* **Taint analysis** β€” [@psalm-taint-source](psalm-taint-source-tag.md),
34+
[@psalm-taint-sink](psalm-taint-sink-tag.md),
35+
[@psalm-taint-escape](psalm-taint-escape-tag.md),
36+
[@psalm-taint-specialize](psalm-taint-specialize-tag.md), and related
37+
[flow tags](psalm-flow-tag.md).
38+
* **Type aliases and generics** β€” [@psalm-type](psalm-type-tag.md),
39+
[@psalm-import-type](psalm-import-type-tag.md),
40+
[@psalm-template](psalm-template-tag.md) (with its
41+
[covariant](psalm-template-covariant-tag.md) and
42+
[contravariant](psalm-template-contravariant-tag.md) forms).
43+
* **Prefixed overrides** β€” [@psalm-param](psalm-param-tag.md),
44+
[@psalm-return](psalm-return-tag.md), [@psalm-var](psalm-var-tag.md),
45+
[@psalm-property](psalm-property-tag.md),
46+
[@psalm-method](psalm-method-tag.md), and the rest, each shadowing its
3547
unprefixed counterpart for Psalm specifically.
3648

3749
<note>

0 commit comments

Comments
Β (0)