Added to documentation and tests that api can be used instead of `p…

…salm-api`
vimeo · Mar 20, 2023 · f3a2182 · f3a2182
1 parent e86a55a
commit f3a2182
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 1 deletion.
diff --git a/docs/annotating_code/supported_annotations.md b/docs/annotating_code/supported_annotations.md
@@ -642,7 +642,7 @@ function (): Generator {
 ```
 This annotation supports only generic types, meaning that e.g. `@psalm-yield string` would be ignored.
 
-### `@psalm-api`
+### `@api`, `@psalm-api`
 
 Used to tell Psalm that a class or method is used, even if no references to it can be
 found. Unused issues will be suppressed.

diff --git a/tests/UnusedCodeTest.php b/tests/UnusedCodeTest.php
@@ -1273,6 +1273,23 @@ public function b(): void {}
                     new A;
                     PHP,
             ],
+            'api with unused class' => [
+                'code' => <<<'PHP'
+                    <?php
+                    /** @api */
+                    class A {}
+                    PHP,
+            ],
+            'api on unused public method' => [
+                'code' => <<<'PHP'
+                    <?php
+                    class A {
+                        /** @api */
+                        public function b(): void {}
+                    }
+                    new A;
+                    PHP,
+            ],
         ];
     }