Skip to content

Commit 0d820bf

Browse files
committed
doc update
1 parent 5a8b2af commit 0d820bf

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

README.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,6 @@ It's an abstract class that needs to be extended to use it.
2525

2626
# Usage
2727

28-
## PHPDoc
29-
30-
You can find auto-generated PHP documentation in the [wiki](https://github.com/marc-mabe/php-enum/wiki).
31-
3228
## Basics
3329

3430
```php
@@ -411,6 +407,19 @@ var_dump($north2->is($north1)); // returns TRUE - equality works in both directi
411407
```
412408

413409

410+
# Generics and Static Code Analyzer
411+
412+
With version 4.3 we have added support for generics and added better type support.
413+
414+
* `EnumSet<T of Enum>`
415+
* `EnumMap<T of Enum>`
416+
417+
Generic types will be detected by [PHPStan](https://phpstan.org/) and [Psaml](https://psalm.dev/).
418+
419+
Additionally, we have developed an [extension for PHPStan](https://github.com/marc-mabe/php-enum-phpstan/)
420+
to make enumerator accessor methods known.
421+
422+
414423
# Why not `SplEnum`
415424

416425
* `SplEnum` is not built-in into PHP and requires pecl extension installed.

0 commit comments

Comments
 (0)