Merge pull request #2448 from lucasmichot/feat/style-docblock-align-c…

…onsistancy Enforce docblock alignment consistancy with phpdoc_align rule
briannesbitt · Sep 11, 2021 · 6903cba · 6903cba
2 parents d04ff92 + bd2432b
commit 6903cba
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 11 deletions.
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -40,7 +40,16 @@
     'php_unit_test_case_static_method_calls' => [
         'call_type' => 'this',
     ],
-    'phpdoc_align' => false,
+    'phpdoc_align' => [
+        'align' => 'vertical',
+        'tags' => [
+            'param',
+            'return',
+            'throws',
+            'type',
+            'var',
+        ],
+    ],
     'phpdoc_indent' => true,
     'phpdoc_inline_tag_normalizer' => true,
     'phpdoc_no_access' => true,

diff --git a/src/Carbon/CarbonInterface.php b/src/Carbon/CarbonInterface.php
@@ -5013,8 +5013,8 @@ public function weeksInYear($dayOfWeek = null, $dayOfYear = null);
      *
      * /!\ Use this method for unit tests only.
      *
-     * @param Closure|static|string|false|null $testNow real or mock Carbon instance
-     * @param Closure|null $callback
+     * @param Closure|static|string|false|null $testNow  real or mock Carbon instance
+     * @param Closure|null                     $callback
      *
      * @return mixed
      */

diff --git a/src/Carbon/CarbonInterval.php b/src/Carbon/CarbonInterval.php
@@ -1905,8 +1905,8 @@ public function subtract($unit, $value = 1)
     /**
      * Add given parameters to the current interval.
      *
-     * @param int $years
-     * @param int $months
+     * @param int       $years
+     * @param int       $months
      * @param int|float $weeks
      * @param int|float $days
      * @param int|float $hours
@@ -1935,8 +1935,8 @@ public function plus(
     /**
      * Add given parameters to the current interval.
      *
-     * @param int $years
-     * @param int $months
+     * @param int       $years
+     * @param int       $months
      * @param int|float $weeks
      * @param int|float $days
      * @param int|float $hours

diff --git a/src/Carbon/Traits/Test.php b/src/Carbon/Traits/Test.php
@@ -61,8 +61,8 @@ public static function setTestNow($testNow = null)
      *
      * /!\ Use this method for unit tests only.
      *
-     * @param Closure|static|string|false|null $testNow real or mock Carbon instance
-     * @param Closure|null $callback
+     * @param Closure|static|string|false|null $testNow  real or mock Carbon instance
+     * @param Closure|null                     $callback
      *
      * @return mixed
      */

diff --git a/tests/Carbon/Exceptions/NotLocaleAwareExceptionTest.php b/tests/Carbon/Exceptions/NotLocaleAwareExceptionTest.php
@@ -32,8 +32,8 @@ public function dataProviderTestNotAPeriodException(): Generator
     /**
      * @dataProvider dataProviderTestNotAPeriodException
      *
-     * @param  mixed  $object
-     * @param  string  $message
+     * @param mixed  $object
+     * @param string $message
      *
      * @return void
      */