DeprecatedScopeResolver - description in PHPDoc

phpstan · Aug 5, 2023 · ce6a85a · ce6a85a
1 parent 0f3fbc3
commit ce6a85a
Showing 1 changed file with 15 additions and 1 deletion.
diff --git a/src/Rules/Deprecations/DeprecatedScopeResolver.php b/src/Rules/Deprecations/DeprecatedScopeResolver.php
@@ -4,7 +4,21 @@
 
 use PHPStan\Analyser\Scope;
 
-/** @api */
+/**
+ * This is the interface for custom deprecated scope resolvers.
+ *
+ * To register it in the configuration file use the `phpstan.deprecations.deprecatedScopeResolver` service tag:
+ *
+ * ```
+ * services:
+ * 	-
+ *		class: App\PHPStan\MyExtension
+ *		tags:
+ *			- phpstan.deprecations.deprecatedScopeResolver
+ * ```
+ *
+ * @api
+ */
 interface DeprecatedScopeResolver
 {