@@ -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 >
3951Nearly every tag in this group is recognized once the <b >Phan</b > platform is
0 commit comments