DeprecatedScopeResolver - description in PHPDoc

ondrejmirtes · ondrejmirtes · commit ce6a85a1c2af · 2023-08-05T11:02:04.000+02:00
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
 {
 
