docs

phpstan · May 21, 2024 · 649495e · 649495e
1 parent f707e4c
commit 649495e
Show file tree

Hide file tree

Showing 3 changed files with 45 additions and 0 deletions.
diff --git a/src/Type/DynamicFunctionParameterOutTypeExtension.php b/src/Type/DynamicFunctionParameterOutTypeExtension.php
@@ -7,6 +7,21 @@
 use PHPStan\Reflection\FunctionReflection;
 use PHPStan\Reflection\ParameterReflection;
 
+/**
+ * This is the interface dynamic parameter out type extensions implement for functions.
+ *
+ * To register it in the configuration file use the `phpstan.dynamicFunctionReturnTypeExtension` service tag:
+ *
+ * ```
+ * services:
+ * 	-
+ *		class: App\PHPStan\MyExtension
+ *		tags:
+ *			- phpstan.dynamicFunctionReturnTypeExtension
+ * ```
+ *
+ * @api
+ */
 interface DynamicFunctionParameterOutTypeExtension
 {
 

diff --git a/src/Type/DynamicMethodParameterOutTypeExtension.php b/src/Type/DynamicMethodParameterOutTypeExtension.php
@@ -7,6 +7,21 @@
 use PHPStan\Reflection\MethodReflection;
 use PHPStan\Reflection\ParameterReflection;
 
+/**
+ * This is the interface dynamic parameter out type extensions implement for non-static methods.
+ *
+ * To register it in the configuration file use the `phpstan.dynamicMethodParameterOutTypeExtension` service tag:
+ *
+ * ```
+ * services:
+ * 	-
+ *		class: App\PHPStan\MyExtension
+ *		tags:
+ *			- phpstan.dynamicMethodParameterOutTypeExtension
+ * ```
+ *
+ * @api
+ */
 interface DynamicMethodParameterOutTypeExtension
 {
 

diff --git a/src/Type/DynamicStaticMethodParameterOutTypeExtension.php b/src/Type/DynamicStaticMethodParameterOutTypeExtension.php
@@ -7,6 +7,21 @@
 use PHPStan\Reflection\MethodReflection;
 use PHPStan\Reflection\ParameterReflection;
 
+/**
+ * This is the interface dynamic parameter out type extensions implement for static methods.
+ *
+ * To register it in the configuration file use the `phpstan.dynamicStaticMethodParameterOutTypeExtension` service tag:
+ *
+ * ```
+ * services:
+ * 	-
+ *		class: App\PHPStan\MyExtension
+ *		tags:
+ *			- phpstan.dynamicStaticMethodParameterOutTypeExtension
+ * ```
+ *
+ * @api
+ */
 interface DynamicStaticMethodParameterOutTypeExtension
 {