Skip to content

Commit 399481e

Browse files
staabmondrejmirtes
authored andcommitted
added some infos on how the plugin works/how to use it
documents the insights from #26 into the README
1 parent bfabc6a commit 399481e

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,14 @@
66

77
* [PHPStan](https://phpstan.org/)
88

9+
This extension emits deprecation warnings on code, which uses properties/functions/methods/classes which are annotated as `@deprecated`.
10+
11+
In case you don't own the code which you want to be considered deprecated, use [PHPStan Stub Files](https://phpstan.org/user-guide/stub-files) to declare deprecations for vendor files like
12+
```
13+
/** @deprecated */
14+
class ThirdPartyClass {}
15+
```
16+
917

1018
## Installation
1119

0 commit comments

Comments
 (0)