Cleanup PHPDoc

briannesbitt · Oct 3, 2023 · 1309c42 · 1309c42
1 parent ff4985e
commit 1309c42
Show file tree

Hide file tree

Showing 8 changed files with 16 additions and 17 deletions.
diff --git a/src/Carbon/CarbonInterface.php b/src/Carbon/CarbonInterface.php
@@ -5125,8 +5125,7 @@ public function weeksInYear($dayOfWeek = null, $dayOfYear = null);
      * @param DateTimeInterface|Closure|static|string|false|null $testNow  real or mock Carbon instance
      * @param Closure(): T                                       $callback
      *
-     * @return mixed
-     * @phpstan-return T
+     * @return T
      */
     public static function withTestNow($testNow, $callback);
 

diff --git a/src/Carbon/PHPStan/AbstractMacro.php b/src/Carbon/PHPStan/AbstractMacro.php
@@ -70,11 +70,9 @@ abstract class AbstractMacro implements BuiltinMethodReflection
     /**
      * Macro constructor.
      *
-     * @param string $className
-     * @phpstan-param class-string $className
-     *
-     * @param string   $methodName
-     * @param callable $macro
+     * @param class-string $className
+     * @param string       $methodName
+     * @param callable     $macro
      */
     public function __construct(string $className, string $methodName, $macro)
     {

diff --git a/src/Carbon/PHPStan/MacroScanner.php b/src/Carbon/PHPStan/MacroScanner.php
@@ -36,10 +36,8 @@ public function __construct(ReflectionProvider $reflectionProvider)
     /**
      * Return true if the given pair class-method is a Carbon macro.
      *
-     * @param string $className
-     * @phpstan-param class-string $className
-     *
-     * @param string $methodName
+     * @param class-string $className
+     * @param string       $methodName
      *
      * @return bool
      */
@@ -61,10 +59,8 @@ public function hasMethod(string $className, string $methodName): bool
     /**
      * Return the Macro for a given pair class-method.
      *
-     * @param string $className
-     * @phpstan-param class-string $className
-     *
-     * @param string $methodName
+     * @param class-string $className
+     * @param string       $methodName
      *
      * @throws ReflectionException
      *

diff --git a/src/Carbon/Traits/Test.php b/src/Carbon/Traits/Test.php
@@ -124,8 +124,7 @@ public static function setTestNowAndTimezone($testNow = null, $tz = null)
      * @param DateTimeInterface|Closure|static|string|false|null $testNow  real or mock Carbon instance
      * @param Closure(): T                                       $callback
      *
-     * @return mixed
-     * @phpstan-return T
+     * @return T
      */
     public static function withTestNow($testNow, $callback)
     {

diff --git a/tests/Carbon/CreateTest.php b/tests/Carbon/CreateTest.php
@@ -309,6 +309,7 @@ public function testParseFromLocale()
 
     /**
      * @dataProvider \Tests\Carbon\CreateTest::dataForLocales
+     *
      * @group localization
      */
     public function testParseFromLocaleForEachLocale($locale)

diff --git a/tests/Carbon/ModifyNearDSTChangeTest.php b/tests/Carbon/ModifyNearDSTChangeTest.php
@@ -25,6 +25,7 @@ class ModifyNearDSTChangeTest extends AbstractTestCase
      * @param string $dateString
      * @param int    $addHours
      * @param string $expected
+     *
      * @dataProvider \Tests\Carbon\ModifyNearDSTChangeTest::dataForTransitionTests
      */
     public function testTransitionInNonDefaultTimezone($dateString, $addHours, $expected)
@@ -41,6 +42,7 @@ public function testTransitionInNonDefaultTimezone($dateString, $addHours, $expe
      * @param string $dateString
      * @param int    $addHours
      * @param string $expected
+     *
      * @dataProvider \Tests\Carbon\ModifyNearDSTChangeTest::dataForTransitionTests
      */
     public function testTransitionInDefaultTimezone($dateString, $addHours, $expected)

diff --git a/tests/CarbonImmutable/ModifyNearDSTChangeTest.php b/tests/CarbonImmutable/ModifyNearDSTChangeTest.php
@@ -25,6 +25,7 @@ class ModifyNearDSTChangeTest extends AbstractTestCase
      * @param string $dateString
      * @param int    $addHours
      * @param string $expected
+     *
      * @dataProvider \Tests\CarbonImmutable\ModifyNearDSTChangeTest::dataForTransitionTests
      */
     public function testTransitionInNonDefaultTimezone($dateString, $addHours, $expected)
@@ -41,6 +42,7 @@ public function testTransitionInNonDefaultTimezone($dateString, $addHours, $expe
      * @param string $dateString
      * @param int    $addHours
      * @param string $expected
+     *
      * @dataProvider \Tests\CarbonImmutable\ModifyNearDSTChangeTest::dataForTransitionTests
      */
     public function testTransitionInDefaultTimezone($dateString, $addHours, $expected)

diff --git a/tests/CarbonTimeZone/ConversionsTest.php b/tests/CarbonTimeZone/ConversionsTest.php
@@ -82,6 +82,7 @@ public static function dataForToOffsetName(): Generator
      * @param string     $date
      * @param string     $expectedOffset
      * @param string|int $timezone
+     *
      * @dataProvider \Tests\CarbonTimeZone\ConversionsTest::dataForToOffsetName
      */
     public function testToOffsetName($date, $expectedOffset, $timezone)
@@ -96,6 +97,7 @@ public function testToOffsetName($date, $expectedOffset, $timezone)
      * @param string     $date
      * @param string     $expectedOffset
      * @param string|int $timezone
+     *
      * @dataProvider \Tests\CarbonTimeZone\ConversionsTest::dataForToOffsetName
      */
     public function testToOffsetNameDateAsParam($date, $expectedOffset, $timezone)