1
0
mirror of https://github.com/danog/psalm.git synced 2024-11-27 04:45:20 +01:00

Merge pull request #9867 from janopae/patch-1

Document classAndDescendants configuration tag
This commit is contained in:
orklah 2023-06-04 23:06:08 +02:00 committed by GitHub
commit e15e03d6cf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -574,10 +574,11 @@ or interfaces defined in a stub file, this stub should be configured with attrib
```
#### <ignoreExceptions>
Optional. A list of exceptions to not report for `checkForThrowsDocblock` or `checkForThrowsInGlobalScope`. If an exception has `onlyGlobalScope` set to `true`, only `checkForThrowsInGlobalScope` is ignored for that exception, e.g.
Optional. A list of exceptions to not report for `checkForThrowsDocblock` or `checkForThrowsInGlobalScope`. The `class` tag will make Psalm ignore only instances of the specified class, while `classAndDescendants` will make Psalm also ignore subclasses. If an exception has `onlyGlobalScope` set to `true`, only `checkForThrowsInGlobalScope` is ignored for that exception, e.g.
```xml
<ignoreExceptions>
<class name="fully\qualified\path\Exc" onlyGlobalScope="true" />
<classAndDescendants name="fully\qualified\path\OtherExc" />
</ignoreExceptions>
```