fix(cs): add rules for docblocks

Author: SamMousa

ecs.php

@@ -27,12 +27,12 @@
     ]);
 
     // A. full sets
-    $ecsConfig->sets([SetList::PSR_12, SetList::SPACES, SetList::STRICT]);
+    $ecsConfig->sets([SetList::PSR_12, SetList::SPACES, SetList::STRICT, SetList::DOCBLOCK]);
 
     $ecsConfig->rule(NotOperatorWithSuccessorSpaceFixer::class);
     $ecsConfig->rule(ArraySyntaxFixer::class);
     $ecsConfig->ruleWithConfiguration(GeneralPhpdocAnnotationRemoveFixer::class, [
-        'annotations' => ['author', 'inheritdoc']
+        'annotations' => ['author', 'inheritdoc', 'package']
     ]);
     $ecsConfig->rule(NoBlankLinesAfterPhpdocFixer::class);
     $ecsConfig->ruleWithConfiguration(NoSuperfluousPhpdocTagsFixer::class, [
@@ -52,6 +52,8 @@
         ]
     ]);
     $ecsConfig->rule(PhpdocIndentFixer::class);
+    $ecsConfig->rule(\PhpCsFixer\Fixer\Phpdoc\AlignMultilineCommentFixer::class);
+
     $ecsConfig->skip([
         ForbiddenFunctionsSniff::class => [
             'tests/**',

src/Codeception/Lib/Connector/Yii2/ConnectionWatcher.php

@@ -11,7 +11,6 @@
 use yii\db\Connection;
 
 /**
- * Class ConnectionWatcher
  * This class will watch for new database connection and store a reference to the connection object.
  * @internal
  */

src/Codeception/Lib/Connector/Yii2/FixturesStore.php

@@ -13,8 +13,6 @@ final class FixturesStore
 
     /**
      * Expects fixtures config
-     *
-     * FixturesStore constructor.
      */
     public function __construct(
         protected mixed $data

src/Codeception/Lib/Connector/Yii2/TransactionForcer.php

@@ -9,10 +9,7 @@
 use yii\db\Transaction;
 
 /**
- * Class TransactionForcer
  * This class adds support for forcing transactions as well as reusing PDO objects.
- *
- * @package Codeception\Lib\Connector\Yii2
  */
 final class TransactionForcer extends ConnectionWatcher
 {

src/Codeception/Module/Yii2.php

@@ -257,7 +257,7 @@ final class Yii2 extends Framework implements ActiveRecord, MultiSession, Parted
     private TransactionForcer $transactionForcer;
 
     /**
-     * @var array<mixed> The contents of $_SERVER upon initialization of this object.
+     * @var array<mixed> The contents of upon initialization of this object.
      * This is only used to restore it upon object destruction.
      * It MUST not be used anywhere else.
      */

tests/cases/simple/helpers/DummyUser.php

@@ -18,7 +18,7 @@ final class DummyUser implements IdentityInterface
     public static function findIdentity($id)
     {
         return null;
-        // TODO: Implement findIdentity() method.
+
     }
 
     /**
@@ -32,7 +32,7 @@ public static function findIdentity($id)
      */
     public static function findIdentityByAccessToken($token, $type = null)
     {
-        // TODO: Implement findIdentityByAccessToken() method.
+
     }
 
     /**
@@ -41,7 +41,7 @@ public static function findIdentityByAccessToken($token, $type = null)
      */
     public function getId()
     {
-        // TODO: Implement getId() method.
+
     }
 
     /**
@@ -58,7 +58,7 @@ public function getId()
      */
     public function getAuthKey()
     {
-        // TODO: Implement getAuthKey() method.
+
     }
 
     /**
@@ -71,6 +71,6 @@ public function getAuthKey()
      */
     public function validateAuthKey($authKey)
     {
-        // TODO: Implement validateAuthKey() method.
+
     }
 }