Updating doc blocks

Author: Florian Krämer

src/Architecture/CatchExceptionOfTypeNotAllowedRule.php

@@ -11,6 +11,11 @@
 use PHPStan\Rules\RuleErrorBuilder;
 
 /**
+ * Specification:
+ *
+ * - Checks if a caught exception type is in the forbidden list.
+ * - Reports an error if a forbidden exception type is caught.
+ *
  * @implements Rule<Catch_>
  */
 class CatchExceptionOfTypeNotAllowedRule implements Rule

src/Architecture/ClassMustBeFinalRule.php

@@ -13,6 +13,7 @@
 
 /**
  * Specification:
+ *
  * - Checks if a class matches a given regex pattern.
  * - Checks if the class is declared as final.
  *

src/Architecture/ClassMustBeReadonlyRule.php

@@ -12,7 +12,10 @@
 
 /**
  * Specification:
+ *
+ * - Checks if a class matches a given regex pattern.
  * - A matching class must be declared as readonly.
+ *
  * @implements Rule<Class_>
  */
 class ClassMustBeReadonlyRule implements Rule

src/Architecture/ClassnameMustMatchPatternRule.php

@@ -14,8 +14,9 @@
 
 /**
  * Specification:
- * PHPStan rule to ensure that classes inside namespaces matching a given regex
- * must have names matching at least one of the provided patterns.
+ *
+ * - Checks if a namespace matches a given regex pattern.
+ * - Ensures that classes inside matching namespaces have names matching at least one of the provided patterns.
  *
  * @implements Rule<Namespace_>
  */

src/Architecture/DependencyConstraintsRule.php

@@ -13,15 +13,13 @@
 use PHPStan\ShouldNotHappenException;
 
 /**
- * A PHPStan rule to enforce dependency constraints between namespaces.
+ * Specification:
  *
- * This rule checks the `use` statements in your PHP code and ensures that
- * certain namespaces do not depend on other namespaces as specified in the
- * configuration.
+ * - Checks use statements in PHP code.
+ * - A class in a namespace matching a given regex is not allowed to depend on any namespace defined by a set of other regexes.
+ * - Reports an error if a forbidden dependency is detected.
  *
- * Specification:
- * - A class in a namespace matching a given regex is not allowed to depend on any namespace defined by a set of
- * other regexes.
+ * @implements Rule<Use_>
  */
 class DependencyConstraintsRule implements Rule
 {

src/Architecture/ForbiddenNamespacesRule.php

@@ -12,14 +12,11 @@
 use PHPStan\ShouldNotHappenException;
 
 /**
- * A PHPStan rule to enforce that certain namespaces can not be declared.
- *
- * This rule checks the `namespace` keyword in your PHP code and ensures that
- * certain namespaces can not be declared as specified in the configuration,
- * to enforce architectural constraints.
- *
  * Specification:
+ *
+ * - Checks namespace declarations in PHP code.
  * - A (sub) namespace matching a given regex is not allowed to be declared.
+ * - Reports an error if a forbidden namespace is declared.
  *
  * @implements Rule<Namespace_>
  */

src/CleanCode/ControlStructureNestingRule.php

@@ -18,7 +18,10 @@
 use PHPStan\ShouldNotHappenException;
 
 /**
- * A rule to check the nesting level of control structures (if, else, elseif, try, catch).
+ * Specification:
+ *
+ * - Checks the nesting level of control structures (if, else, elseif, try, catch).
+ * - Reports an error if the nesting level exceeds the configured maximum.
  *
  * @implements Rule<Node>
  */

src/CleanCode/MaxLineLengthRule.php

@@ -13,7 +13,11 @@
 use PHPStan\ShouldNotHappenException;
 
 /**
- * A configurable rule to check the maximum line length.
+ * Specification:
+ *
+ * - Checks if a line exceeds the configured maximum line length.
+ * - Optionally excludes files matching specific patterns.
+ * - Optionally ignores use statements.
  *
  * @implements Rule<Node>
  */

src/CleanCode/TooManyArgumentsRule.php

@@ -13,7 +13,11 @@
 use PHPStan\ShouldNotHappenException;
 
 /**
- * A configurable rule to check the number of arguments in a method.
+ * Specification:
+ *
+ * - Checks if a method has more arguments than the configured maximum.
+ * - Optionally applies only to classes matching specific patterns.
+ * - Reports an error if the number of arguments exceeds the configured maximum.
  *
  * @implements Rule<ClassMethod>
  */