[PHPDoc] Prefixed template mentioning annotation with phpstan- (#434)

ibexa · Oct 9, 2024 · c338dc5 · c338dc5
1 parent f6dde52
commit c338dc5
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 7 deletions.
diff --git a/src/contracts/Pool/Pool.php b/src/contracts/Pool/Pool.php
@@ -20,15 +20,15 @@ final class Pool implements PoolInterface
 
     private string $class;
 
-    /** @var iterable<string,T> */
+    /** @phpstan-var iterable<string,T> */
     private iterable $entries;
 
     private string $exceptionArgumentName = '$alias';
 
     private string $exceptionMessageTemplate = self::DEFAULT_EXCEPTION_MESSAGE_TEMPLATE;
 
     /**
-     * @param iterable<string,T> $entries
+     * @phpstan-param iterable<string,T> $entries
      */
     public function __construct(string $class, iterable $entries = [])
     {
@@ -44,7 +44,7 @@ public function has(string $alias): bool
     /**
      * @throws \Ibexa\Contracts\Core\Repository\Exceptions\InvalidArgumentException
      *
-     * @return T
+     * @phpstan-return T
      */
     public function get(string $alias)
     {
@@ -64,7 +64,7 @@ public function get(string $alias)
     }
 
     /**
-     * @return T|null
+     * @phpstan-return T|null
      */
     private function findEntry(string $needle)
     {
@@ -78,7 +78,7 @@ private function findEntry(string $needle)
     }
 
     /**
-     * @return iterable<string,T>
+     * @phpstan-return iterable<string,T>
      */
     public function getEntries(): iterable
     {

diff --git a/src/contracts/Pool/PoolInterface.php b/src/contracts/Pool/PoolInterface.php
@@ -18,12 +18,12 @@ public function has(string $alias): bool;
     /**
      * @throws \Ibexa\Contracts\Core\Repository\Exceptions\InvalidArgumentException
      *
-     * @return T
+     * @phpstan-return T
      */
     public function get(string $alias);
 
     /**
-     * @return iterable<string,T>
+     * @phpstan-return iterable<string,T>
      */
     public function getEntries(): iterable;