Use native PHPDocs wherever possible

phpstan · Dec 11, 2024 · 4d3a9ab · 4d3a9ab
1 parent fba167c
commit 4d3a9ab
Show file tree

Hide file tree

Showing 8 changed files with 24 additions and 37 deletions.
diff --git a/src/Collectors/Collector.php b/src/Collectors/Collector.php
@@ -20,19 +20,19 @@
  * Learn more: https://phpstan.org/developing-extensions/collectors
  *
  * @api
- * @phpstan-template-covariant TNodeType of Node
- * @phpstan-template-covariant TValue
+ * @template-covariant TNodeType of Node
+ * @template-covariant TValue
  */
 interface Collector
 {
 
 	/**
-	 * @phpstan-return class-string<TNodeType>
+	 * @return class-string<TNodeType>
 	 */
 	public function getNodeType(): string;
 
 	/**
-	 * @phpstan-param TNodeType $node
+	 * @param TNodeType $node
 	 * @return TValue|null Collected data
 	 */
 	public function processNode(Node $node, Scope $scope);

diff --git a/src/Collectors/Registry.php b/src/Collectors/Registry.php
@@ -27,10 +27,8 @@ public function __construct(array $collectors)
 
 	/**
 	 * @template TNodeType of Node
-	 * @phpstan-param class-string<TNodeType> $nodeType
-	 * @param Node $nodeType
-	 * @phpstan-return array<Collector<TNodeType, mixed>>
-	 * @return Collector[]
+	 * @param class-string<TNodeType> $nodeType
+	 * @return array<Collector<TNodeType, mixed>>
 	 */
 	public function getCollectors(string $nodeType): array
 	{
@@ -48,8 +46,7 @@ public function getCollectors(string $nodeType): array
 		}
 
 		/**
-		 * @phpstan-var array<Collector<TNodeType, mixed>> $selectedCollectors
-		 * @var Collector[] $selectedCollectors
+		 * @var array<Collector<TNodeType, mixed>> $selectedCollectors
 		 */
 		$selectedCollectors = $this->cache[$nodeType];
 

diff --git a/src/DependencyInjection/Container.php b/src/DependencyInjection/Container.php
@@ -14,10 +14,9 @@ public function hasService(string $serviceName): bool;
 	public function getService(string $serviceName);
 
 	/**
-	 * @phpstan-template T of object
-	 * @phpstan-param class-string<T> $className
-	 * @phpstan-return T
-	 * @return mixed
+	 * @template T of object
+	 * @param class-string<T> $className
+	 * @return T
 	 */
 	public function getByType(string $className);
 

diff --git a/src/DependencyInjection/Nette/NetteContainer.php b/src/DependencyInjection/Nette/NetteContainer.php
@@ -32,10 +32,9 @@ public function getService(string $serviceName)
 	}
 
 	/**
-	 * @phpstan-template T of object
-	 * @phpstan-param class-string<T> $className
-	 * @phpstan-return T
-	 * @return mixed
+	 * @template T of object
+	 * @param class-string<T> $className
+	 * @return T
 	 */
 	public function getByType(string $className)
 	{

diff --git a/src/Rules/DirectRegistry.php b/src/Rules/DirectRegistry.php
@@ -30,10 +30,8 @@ public function __construct(array $rules)
 
 	/**
 	 * @template TNodeType of Node
-	 * @phpstan-param class-string<TNodeType> $nodeType
-	 * @param Node $nodeType
-	 * @phpstan-return array<Rule<TNodeType>>
-	 * @return Rule[]
+	 * @param class-string<TNodeType> $nodeType
+	 * @return array<Rule<TNodeType>>
 	 */
 	public function getRules(string $nodeType): array
 	{
@@ -51,8 +49,7 @@ public function getRules(string $nodeType): array
 		}
 
 		/**
-		 * @phpstan-var array<Rule<TNodeType>> $selectedRules
-		 * @var Rule[] $selectedRules
+		 * @var array<Rule<TNodeType>> $selectedRules
 		 */
 		$selectedRules = $this->cache[$nodeType];
 

diff --git a/src/Rules/LazyRegistry.php b/src/Rules/LazyRegistry.php
@@ -24,10 +24,8 @@ public function __construct(private Container $container)
 
 	/**
 	 * @template TNodeType of Node
-	 * @phpstan-param class-string<TNodeType> $nodeType
-	 * @param Node $nodeType
-	 * @phpstan-return array<Rule<TNodeType>>
-	 * @return Rule[]
+	 * @param class-string<TNodeType> $nodeType
+	 * @return array<Rule<TNodeType>>
 	 */
 	public function getRules(string $nodeType): array
 	{
@@ -46,8 +44,7 @@ public function getRules(string $nodeType): array
 		}
 
 		/**
-		 * @phpstan-var array<Rule<TNodeType>> $selectedRules
-		 * @var Rule[] $selectedRules
+		 * @var array<Rule<TNodeType>> $selectedRules
 		 */
 		$selectedRules = $this->cache[$nodeType];
 

diff --git a/src/Rules/Registry.php b/src/Rules/Registry.php
@@ -9,10 +9,8 @@ interface Registry
 
 	/**
 	 * @template TNodeType of Node
-	 * @phpstan-param class-string<TNodeType> $nodeType
-	 * @param Node $nodeType
-	 * @phpstan-return array<Rule<TNodeType>>
-	 * @return Rule[]
+	 * @param class-string<TNodeType> $nodeType
+	 * @return array<Rule<TNodeType>>
 	 */
 	public function getRules(string $nodeType): array;
 

diff --git a/stubs/bleedingEdge/Rule.stub b/stubs/bleedingEdge/Rule.stub
@@ -7,18 +7,18 @@ use PHPStan\Analyser\Scope;
 
 /**
  * @api
- * @phpstan-template TNodeType of Node
+ * @template TNodeType of Node
  */
 interface Rule
 {
 
 	/**
-	 * @phpstan-return class-string<TNodeType>
+	 * @return class-string<TNodeType>
 	 */
 	public function getNodeType(): string;
 
 	/**
-	 * @phpstan-param TNodeType $node
+	 * @param TNodeType $node
 	 * @return list<IdentifierRuleError>
 	 */
 	public function processNode(Node $node, Scope $scope): array;