Clean up redundant docblocks

brick · Dec 11, 2020 · 2d9a1a1 · 2d9a1a1
1 parent 991a050
commit 2d9a1a1
Show file tree

Hide file tree

Showing 16 changed files with 73 additions and 396 deletions.
diff --git a/tests/AbstractTestCase.php b/tests/AbstractTestCase.php
@@ -21,12 +21,6 @@
  */
 abstract class AbstractTestCase extends TestCase
 {
-    /**
-     * @param string     $expected
-     * @param BigDecimal $actual
-     *
-     * @return void
-     */
     final protected function assertBigDecimalIs(string $expected, BigDecimal $actual) : void
     {
         self::assertSame($expected, (string) $actual);
@@ -36,8 +30,6 @@ final protected function assertBigDecimalIs(string $expected, BigDecimal $actual
      * @param string $expectedAmount   The expected decimal amount.
      * @param string $expectedCurrency The expected currency code.
      * @param Money  $actual           The money to test.
-     *
-     * @return void
      */
     final protected function assertMoneyEquals(string $expectedAmount, string $expectedCurrency, Money $actual) : void
     {
@@ -49,8 +41,6 @@ final protected function assertMoneyEquals(string $expectedAmount, string $expec
      * @param string       $expected The expected string representation of the Money.
      * @param Money        $actual   The money to test.
      * @param Context|null $context  An optional context to check against the Money.
-     *
-     * @return void
      */
     final protected function assertMoneyIs(string $expected, Money $actual, ?Context $context = null) : void
     {
@@ -64,8 +54,6 @@ final protected function assertMoneyIs(string $expected, Money $actual, ?Context
     /**
      * @param string[] $expected
      * @param Money[]  $actual
-     *
-     * @return void
      */
     final protected function assertMoniesAre(array $expected, array $actual) : void
     {
@@ -77,23 +65,11 @@ final protected function assertMoniesAre(array $expected, array $actual) : void
         self::assertSame($expected, $actual);
     }
 
-    /**
-     * @param string    $expected
-     * @param BigNumber $actual
-     *
-     * @return void
-     */
     final protected function assertBigNumberEquals(string $expected, BigNumber $actual) : void
     {
         self::assertTrue($actual->isEqualTo($expected), $actual . ' != ' . $expected);
     }
 
-    /**
-     * @param array    $expectedAmounts
-     * @param MoneyBag $moneyBag
-     *
-     * @return void
-     */
     final protected function assertMoneyBagContains(array $expectedAmounts, MoneyBag $moneyBag) : void
     {
         // Test get() on each currency
@@ -113,26 +89,11 @@ final protected function assertMoneyBagContains(array $expectedAmounts, MoneyBag
         }
     }
 
-    /**
-     * @param string        $expected
-     * @param RationalMoney $actual
-     *
-     * @return void
-     */
     final protected function assertRationalMoneyEquals(string $expected, RationalMoney $actual) : void
     {
         self::assertSame($expected, (string) $actual);
     }
 
-    /**
-     * @param string   $currencyCode
-     * @param int      $numericCode
-     * @param string   $name
-     * @param int      $defaultFractionDigits
-     * @param Currency $currency
-     *
-     * @return void
-     */
     final protected function assertCurrencyEquals(string $currencyCode, int $numericCode, string $name, int $defaultFractionDigits, Currency $currency) : void
     {
         self::assertSame($currencyCode, $currency->getCurrencyCode());
@@ -143,8 +104,6 @@ final protected function assertCurrencyEquals(string $currencyCode, int $numeric
 
     /**
      * @param mixed $value
-     *
-     * @return bool
      */
     final protected function isExceptionClass($value) : bool
     {

diff --git a/tests/Context/AutoContextTest.php b/tests/Context/AutoContextTest.php
@@ -20,11 +20,6 @@ class AutoContextTest extends AbstractTestCase
 {
     /**
      * @dataProvider providerApplyTo
-     *
-     * @param string $amount
-     * @param string $currency
-     * @param int    $roundingMode
-     * @param string $expected
      */
     public function testApplyTo(string $amount, string $currency, int $roundingMode, string $expected) : void
     {
@@ -44,9 +39,6 @@ public function testApplyTo(string $amount, string $currency, int $roundingMode,
         }
     }
 
-    /**
-     * @return array
-     */
     public function providerApplyTo() : array
     {
         return [

diff --git a/tests/Context/CashContextTest.php b/tests/Context/CashContextTest.php
@@ -19,12 +19,6 @@ class CashContextTest extends AbstractTestCase
 {
     /**
      * @dataProvider providerApplyTo
-     *
-     * @param int    $step
-     * @param string $amount
-     * @param string $currency
-     * @param int    $roundingMode
-     * @param string $expected
      */
     public function testApplyTo(int $step, string $amount, string $currency, int $roundingMode, string $expected) : void
     {
@@ -44,9 +38,6 @@ public function testApplyTo(int $step, string $amount, string $currency, int $ro
         }
     }
 
-    /**
-     * @return array
-     */
     public function providerApplyTo() : array
     {
         return [

diff --git a/tests/Context/CustomContextTest.php b/tests/Context/CustomContextTest.php
@@ -19,13 +19,6 @@ class CustomContextTest extends AbstractTestCase
 {
     /**
      * @dataProvider providerApplyTo
-     *
-     * @param int    $scale
-     * @param int    $step
-     * @param string $amount
-     * @param string $currency
-     * @param int    $roundingMode
-     * @param string $expected
      */
     public function testApplyTo(int $scale, int $step, string $amount, string $currency, int $roundingMode, string $expected) : void
     {
@@ -45,9 +38,6 @@ public function testApplyTo(int $scale, int $step, string $amount, string $curre
         }
     }
 
-    /**
-     * @return array
-     */
     public function providerApplyTo() : array
     {
         return [

diff --git a/tests/Context/DefaultContextTest.php b/tests/Context/DefaultContextTest.php
@@ -19,11 +19,6 @@ class DefaultContextTest extends AbstractTestCase
 {
     /**
      * @dataProvider providerApplyTo
-     *
-     * @param string $amount
-     * @param string $currency
-     * @param int    $roundingMode
-     * @param string $expected
      */
     public function testApplyTo(string $amount, string $currency, int $roundingMode, string $expected) : void
     {
@@ -43,9 +38,6 @@ public function testApplyTo(string $amount, string $currency, int $roundingMode,
         }
     }
 
-    /**
-     * @return array
-     */
     public function providerApplyTo() : array
     {
         return [

diff --git a/tests/CurrencyConverterTest.php b/tests/CurrencyConverterTest.php
@@ -23,9 +23,6 @@
  */
 class CurrencyConverterTest extends AbstractTestCase
 {
-    /**
-     * @return CurrencyConverter
-     */
     private function createCurrencyConverter() : CurrencyConverter
     {
         $exchangeRateProvider = new ConfigurableProvider();
@@ -60,9 +57,6 @@ public function testConvertMoney(array $money, string $toCurrency, int $rounding
         }
     }
 
-    /**
-     * @return array
-     */
     public function providerConvertMoney() : array
     {
         return [
@@ -84,7 +78,7 @@ public function providerConvertMoney() : array
     /**
      * @dataProvider providerConvertMoneyBag
      *
-     * @param array   $monies       The mixed monies to add.
+     * @param array   $monies       The mixed currency monies to add.
      * @param string  $currency     The target currency code.
      * @param Context $context      The target context.
      * @param int     $roundingMode The rounding mode to use.
@@ -107,9 +101,6 @@ public function testConvertMoneyBag(array $monies, string $currency, Context $co
         $this->assertMoneyIs($total, $currencyConverter->convert($moneyBag, $currency, $roundingMode));
     }
 
-    /**
-     * @return array
-     */
     public function providerConvertMoneyBag() : array
     {
         return [
@@ -124,9 +115,9 @@ public function providerConvertMoneyBag() : array
     /**
      * @dataProvider providerConvertMoneyBagToRational
      *
-     * @param array   $monies        The mixed monies to add.
-     * @param string  $currency      The target currency code.
-     * @param string  $expectedTotal The expected total.
+     * @param array  $monies        The mixed monies to add.
+     * @param string $currency      The target currency code.
+     * @param string $expectedTotal The expected total.
      */
     public function testConvertMoneyBagToRational(array $monies, string $currency, string $expectedTotal) : void
     {
@@ -147,9 +138,6 @@ public function testConvertMoneyBagToRational(array $monies, string $currency, s
         $this->assertRationalMoneyEquals($expectedTotal, $actualTotal);
     }
 
-    /**
-     * @return array
-     */
     public function providerConvertMoneyBagToRational() : array
     {
         return [
@@ -183,9 +171,6 @@ public function testConvertRationalMoney(array $money, string $toCurrency, int $
         }
     }
 
-    /**
-     * @return array
-     */
     public function providerConvertRationalMoney() : array
     {
         return [

diff --git a/tests/CurrencyTest.php b/tests/CurrencyTest.php
@@ -29,9 +29,6 @@ public function testOf(string $currencyCode, int $numericCode, int $fractionDigi
         $this->assertCurrencyEquals($currencyCode, $numericCode, $name, $fractionDigits, $currency);
     }
 
-    /**
-     * @return array
-     */
     public function providerOf() : array
     {
         return [
@@ -54,9 +51,6 @@ public function testOfUnknownCurrencyCode($currencyCode) : void
         Currency::of($currencyCode);
     }
 
-    /**
-     * @return array
-     */
     public function providerOfUnknownCurrencyCode() : array
     {
         return [
@@ -78,9 +72,6 @@ public function testOfReturnsSameInstance() : void
 
     /**
      * @dataProvider providerOfCountry
-     *
-     * @param string $countryCode
-     * @param string $expected
      */
     public function testOfCountry(string $countryCode, string $expected) : void
     {
@@ -96,9 +87,6 @@ public function testOfCountry(string $countryCode, string $expected) : void
         }
     }
 
-    /**
-     * @return array
-     */
     public function providerOfCountry() : array
     {
         return [