Quality Assurance > Missing PHPDoc comment

Leandro F. L · lfluvisotto · commit c7c0a992d83d · 2019-10-15T22:51:54.000-03:00
diff --git a/app/code/Magento/AuthorizenetAcceptjs/Test/Unit/Gateway/ConfigTest.php b/app/code/Magento/AuthorizenetAcceptjs/Test/Unit/Gateway/ConfigTest.php
@@ -81,6 +81,9 @@ public function testGetSolutionIdSandbox($environment, $expectedSolution)
         $this->assertEquals($expectedSolution, $this->model->getSolutionId(123));
     }
 
+    /**
+     * @return array
+     */
     public function configMapProvider()
     {
         return [
@@ -97,6 +100,10 @@ public function configMapProvider()
             ['getTransactionInfoSyncKeys', 'transactionSyncKeys', 'a,b,c', ['a', 'b', 'c']],
         ];
     }
+
+    /**
+     * @return array
+     */
     public function environmentUrlProvider()
     {
         return [
@@ -105,6 +112,9 @@ public function environmentUrlProvider()
         ];
     }
 
+    /**
+     * @return array
+     */
     public function environmentSolutionProvider()
     {
         return [
diff --git a/app/code/Magento/AuthorizenetAcceptjs/Test/Unit/Gateway/Request/AddressDataBuilderTest.php b/app/code/Magento/AuthorizenetAcceptjs/Test/Unit/Gateway/Request/AddressDataBuilderTest.php
@@ -108,13 +108,22 @@ public function testBuildWithBothAddresses()
         $this->assertEquals('abc', $result['transactionRequest']['customerIP']);
     }
 
+    /**
+     * @param $responseData
+     * @param $addressPrefix
+     */
     private function validateAddressData($responseData, $addressPrefix)
     {
         foreach ($this->mockAddressData as $fieldValue => $field) {
             $this->assertEquals($addressPrefix . $field['sampleData'], $responseData[$fieldValue]);
         }
     }
 
+    /**
+     * @param $prefix
+     *
+     * @return \PHPUnit\Framework\MockObject\MockObject
+     */
     private function createAddressMock($prefix)
     {
         $addressAdapterMock = $this->createMock(AddressAdapterInterface::class);
diff --git a/app/code/Magento/AuthorizenetAcceptjs/Test/Unit/Gateway/Response/PaymentReviewStatusHandlerTest.php b/app/code/Magento/AuthorizenetAcceptjs/Test/Unit/Gateway/Response/PaymentReviewStatusHandlerTest.php
@@ -112,6 +112,9 @@ public function testDoesNothingWhenPending(string $status)
         $this->handler->handle($subject, $response);
     }
 
+    /**
+     * @return array
+     */
     public function pendingTransactionStatusesProvider()
     {
         return [
@@ -120,6 +123,9 @@ public function pendingTransactionStatusesProvider()
         ];
     }
 
+    /**
+     * @return array
+     */
     public function declinedTransactionStatusesProvider()
     {
         return [
diff --git a/app/code/Magento/Catalog/Test/Unit/Model/Category/FileInfoTest.php b/app/code/Magento/Catalog/Test/Unit/Model/Category/FileInfoTest.php
@@ -191,6 +191,9 @@ public function testIsExist($fileName, $fileMediaPath)
         $this->assertTrue($this->model->isExist($fileName));
     }
 
+    /**
+     * @return array
+     */
     public function isExistProvider()
     {
         return [
@@ -213,6 +216,9 @@ public function testIsBeginsWithMediaDirectoryPath($fileName, $expected)
         $this->assertEquals($expected, $this->model->isBeginsWithMediaDirectoryPath($fileName));
     }
 
+    /**
+     * @return array
+     */
     public function isBeginsWithMediaDirectoryPathProvider()
     {
         return [
diff --git a/app/code/Magento/Catalog/Test/Unit/Model/ProductTest.php b/app/code/Magento/Catalog/Test/Unit/Model/ProductTest.php
@@ -486,6 +486,9 @@ public function testGetStoreSingleSiteModelIds(
         $this->assertEquals($websiteIDs, $this->model->getStoreIds());
     }
 
+    /**
+     * @return array
+     */
     public function getSingleStoreIds()
     {
         return [
diff --git a/app/code/Magento/Checkout/Test/Unit/Model/Cart/RequestQuantityProcessorTest.php b/app/code/Magento/Checkout/Test/Unit/Model/Cart/RequestQuantityProcessorTest.php
@@ -48,6 +48,9 @@ public function testProcess($cartData, $expected)
         $this->assertEquals($this->requestProcessor->process($cartData), $expected);
     }
 
+    /**
+     * @return array
+     */
     public function cartDataProvider()
     {
         return [
diff --git a/app/code/Magento/ImportExport/Test/Unit/Model/ImportTest.php b/app/code/Magento/ImportExport/Test/Unit/Model/ImportTest.php
@@ -640,6 +640,9 @@ public function testGetUnknownEntity($entity)
         $import->getEntity();
     }
 
+    /**
+     * @return array
+     */
     public function unknownEntitiesProvider()
     {
         return [
diff --git a/app/code/Magento/LayeredNavigation/Test/Unit/Block/NavigationTest.php b/app/code/Magento/LayeredNavigation/Test/Unit/Block/NavigationTest.php
@@ -100,7 +100,7 @@ public function testCanShowBlock()
             ->method('isEnabled')
             ->with($this->catalogLayerMock, $filters)
             ->will($this->returnValue($enabled));
-        
+
         $category = $this->createMock(Category::class);
         $this->catalogLayerMock->expects($this->atLeastOnce())->method('getCurrentCategory')->willReturn($category);
         $category->expects($this->once())->method('getDisplayMode')->willReturn(Category::DM_PRODUCT);
@@ -119,12 +119,12 @@ public function testCanShowBlock()
     public function testCanShowBlockWithDifferentDisplayModes(string $mode, bool $result)
     {
         $filters = ['To' => 'be', 'or' => 'not', 'to' => 'be'];
-        
+
         $this->filterListMock->expects($this->atLeastOnce())->method('getFilters')
             ->with($this->catalogLayerMock)
             ->will($this->returnValue($filters));
         $this->assertEquals($filters, $this->model->getFilters());
-        
+
         $this->visibilityFlagMock
             ->expects($this->any())
             ->method('isEnabled')
@@ -137,6 +137,9 @@ public function testCanShowBlockWithDifferentDisplayModes(string $mode, bool $re
         $this->assertEquals($result, $this->model->canShowBlock());
     }
 
+    /**
+     * @return array
+     */
     public function canShowBlockDataProvider()
     {
         return [
diff --git a/app/code/Magento/Sales/Test/Unit/Model/OrderTest.php b/app/code/Magento/Sales/Test/Unit/Model/OrderTest.php
@@ -1253,6 +1253,9 @@ public function testGetCreatedAtFormattedUsesCorrectLocale()
         $this->order->getCreatedAtFormatted(\IntlDateFormatter::SHORT);
     }
 
+    /**
+     * @return array
+     */
     public function notInvoicingStatesProvider()
     {
         return [
@@ -1262,6 +1265,9 @@ public function notInvoicingStatesProvider()
         ];
     }
 
+    /**
+     * @return array
+     */
     public function canNotCreditMemoStatesProvider()
     {
         return [
diff --git a/app/code/Magento/Sales/Test/Unit/Model/ResourceModel/Order/Handler/StateTest.php b/app/code/Magento/Sales/Test/Unit/Model/ResourceModel/Order/Handler/StateTest.php
@@ -103,6 +103,9 @@ public function testCheck(
         $this->assertEquals($expectedState, $this->orderMock->getState());
     }
 
+    /**
+     * @return array
+     */
     public function stateCheckDataProvider()
     {
         return [
diff --git a/app/code/Magento/Search/Test/Unit/Model/Search/PageSizeProviderTest.php b/app/code/Magento/Search/Test/Unit/Model/Search/PageSizeProviderTest.php
@@ -50,6 +50,9 @@ public function testGetPageSize($searchEngine, $size)
         $this->assertEquals($size, $this->model->getMaxPageSize());
     }
 
+    /**
+     * @return array
+     */
     public function getPageSizeDataProvider()
     {
         return [
diff --git a/app/functions.php b/app/functions.php
@@ -13,6 +13,9 @@
  * @return \Magento\Framework\Phrase
  */
 if (!function_exists('__')) {
+    /**
+     * @return \Magento\Framework\Phrase
+     */
     function __()
     {
         $argc = func_get_args();
diff --git a/lib/internal/Magento/Framework/Encryption/Test/Unit/Adapter/McryptTest.php b/lib/internal/Magento/Framework/Encryption/Test/Unit/Adapter/McryptTest.php
@@ -28,6 +28,11 @@ protected function setUp()
         $this->key = substr(__CLASS__, -32, 32);
     }
 
+    /**
+     * @param int $length
+     *
+     * @return string
+     */
     protected function getRandomString(int $length): string
     {
         $result = '';
@@ -48,18 +53,33 @@ private function requireCipherInfo()
         }
     }
 
+    /**
+     * @param string $cipherName
+     * @param string $modeName
+     *
+     * @return int
+     */
     private function getKeySize(string $cipherName, string $modeName): int
     {
         $this->requireCipherInfo();
         return self::$cipherInfo[$cipherName][$modeName]['key_size'];
     }
 
+    /**
+     * @param string $cipherName
+     * @param string $modeName
+     *
+     * @return int
+     */
     private function getInitVectorSize(string $cipherName, string $modeName): int
     {
         $this->requireCipherInfo();
         return self::$cipherInfo[$cipherName][$modeName]['iv_size'];
     }
 
+    /**
+     * @return array
+     */
     public function getCipherModeCombinations(): array
     {
         $result = [];
@@ -87,6 +107,9 @@ public function testConstructor(string $cipher, string $mode)
         $this->assertEquals($initVector, $crypt->getInitVector());
     }
 
+    /**
+     * @return array
+     */
     public function getConstructorExceptionData(): array
     {
         $key = substr(__CLASS__, -32, 32);
@@ -130,6 +153,9 @@ public function testConstructorDefaults()
         $this->assertEquals($cryptExpected->getInitVector(), $cryptActual->getInitVector());
     }
 
+    /**
+     * @return array
+     */
     public function getCryptData(): array
     {
         $fixturesFilename = __DIR__ . '/../Crypt/_files/_crypt_fixtures.php';
diff --git a/lib/internal/Magento/Framework/Encryption/Test/Unit/KeyValidatorTest.php b/lib/internal/Magento/Framework/Encryption/Test/Unit/KeyValidatorTest.php
@@ -33,6 +33,9 @@ public function testIsValid($key, $expected = true)
         $this->assertEquals($expected, $this->keyValidator->isValid($key));
     }
 
+    /**
+     * @return array
+     */
     public function isValidDataProvider() : array
     {
         return [
diff --git a/lib/internal/Magento/Framework/Indexer/Test/Unit/MultiDimensionProviderTest.php b/lib/internal/Magento/Framework/Indexer/Test/Unit/MultiDimensionProviderTest.php
@@ -210,6 +210,11 @@ public function testMultiDimensionProviderWithMixedDataProvider()
         }
     }
 
+    /**
+     * @param $dimensions
+     *
+     * @return \PHPUnit\Framework\MockObject\MockObject
+     */
     private function getDimensionProviderMock($dimensions)
     {
         $dimensionProviderMock = $this->getMockBuilder(DimensionProviderInterface::class)
@@ -233,6 +238,12 @@ function () use ($dimensions) {
         return $dimensionProviderMock;
     }
 
+    /**
+     * @param string $name
+     * @param string $value
+     *
+     * @return \PHPUnit\Framework\MockObject\MockObject
+     */
     private function getDimensionMock(string $name, string $value)
     {
         $dimensionMock = $this->getMockBuilder(Dimension::class)
diff --git a/lib/internal/Magento/Framework/Serialize/Test/Unit/Serializer/JsonHexTagTest.php b/lib/internal/Magento/Framework/Serialize/Test/Unit/Serializer/JsonHexTagTest.php
@@ -17,7 +17,7 @@ class JsonHexTagTest extends \PHPUnit\Framework\TestCase
      * @var \Magento\Framework\Serialize\Serializer\Json
      */
     private $json;
-    
+
     protected function setUp()
     {
         $objectManager = new \Magento\Framework\TestFramework\Unit\Helper\ObjectManager($this);
@@ -37,6 +37,9 @@ public function testSerialize($value, $expected)
         );
     }
 
+    /**
+     * @return array
+     */
     public function serializeDataProvider()
     {
         $dataObject = new DataObject(['something']);
diff --git a/setup/src/Magento/Setup/Test/Unit/Console/Command/ModuleConfigStatusCommandTest.php b/setup/src/Magento/Setup/Test/Unit/Console/Command/ModuleConfigStatusCommandTest.php
@@ -49,6 +49,9 @@ public function testExecute(array $currentConfig, array $correctConfig, string $
         $this->assertEquals($expectedOutput, $tester->getDisplay());
     }
 
+    /**
+     * @return array
+     */
     public function executeDataProvider()
     {
         $successMessage = 'The modules configuration is up to date.' . PHP_EOL;
diff --git a/setup/src/Magento/Setup/Test/Unit/Controller/EnvironmentTest.php b/setup/src/Magento/Setup/Test/Unit/Controller/EnvironmentTest.php
@@ -294,6 +294,13 @@ public function testIndexAction()
         $this->assertInstanceOf(\Zend\View\Model\JsonModel::class, $model);
     }
 
+    /**
+     * @param \PHPUnit\Framework\MockObject\MockObject $request
+     * @param \PHPUnit\Framework\MockObject\MockObject $response
+     * @param \PHPUnit\Framework\MockObject\MockObject $routeMatch
+     *
+     * @return \PHPUnit\Framework\MockObject\MockObject
+     */
     protected function getMvcEventMock(
         MockObject $request,
         MockObject $response,

Original file line number	Diff line number	Diff line change
`@@ -81,6 +81,9 @@ public function testGetSolutionIdSandbox($environment, $expectedSolution)`
`81`	`81`	`$this->assertEquals($expectedSolution, $this->model->getSolutionId(123));`
`82`	`82`	`}`
`83`	`83`
	`84`	`+ /**`
	`85`	`+ * @return array`
	`86`	`+ */`
`84`	`87`	`public function configMapProvider()`
`85`	`88`	`{`
`86`	`89`	`return [`
`@@ -97,6 +100,10 @@ public function configMapProvider()`
`97`	`100`	`['getTransactionInfoSyncKeys', 'transactionSyncKeys', 'a,b,c', ['a', 'b', 'c']],`
`98`	`101`	`];`
`99`	`102`	`}`
	`103`	`+`
	`104`	`+ /**`
	`105`	`+ * @return array`
	`106`	`+ */`
`100`	`107`	`public function environmentUrlProvider()`
`101`	`108`	`{`
`102`	`109`	`return [`
`@@ -105,6 +112,9 @@ public function environmentUrlProvider()`
`105`	`112`	`];`
`106`	`113`	`}`
`107`	`114`
	`115`	`+ /**`
	`116`	`+ * @return array`
	`117`	`+ */`
`108`	`118`	`public function environmentSolutionProvider()`
`109`	`119`	`{`
`110`	`120`	`return [`
Original file line number	Diff line number	Diff line change
`@@ -108,13 +108,22 @@ public function testBuildWithBothAddresses()`
`108`	`108`	`$this->assertEquals('abc', $result['transactionRequest']['customerIP']);`
`109`	`109`	`}`
`110`	`110`
	`111`	`+ /**`
	`112`	`+ * @param $responseData`
	`113`	`+ * @param $addressPrefix`
	`114`	`+ */`
`111`	`115`	`private function validateAddressData($responseData, $addressPrefix)`
`112`	`116`	`{`
`113`	`117`	`foreach ($this->mockAddressData as $fieldValue => $field) {`
`114`	`118`	`$this->assertEquals($addressPrefix . $field['sampleData'], $responseData[$fieldValue]);`
`115`	`119`	`}`
`116`	`120`	`}`
`117`	`121`
	`122`	`+ /**`
	`123`	`+ * @param $prefix`
	`124`	`+ *`
	`125`	`+ * @return \PHPUnit\Framework\MockObject\MockObject`
	`126`	`+ */`
`118`	`127`	`private function createAddressMock($prefix)`
`119`	`128`	`{`
`120`	`129`	`$addressAdapterMock = $this->createMock(AddressAdapterInterface::class);`
Original file line number	Diff line number	Diff line change
`@@ -112,6 +112,9 @@ public function testDoesNothingWhenPending(string $status)`
`112`	`112`	`$this->handler->handle($subject, $response);`
`113`	`113`	`}`
`114`	`114`
	`115`	`+ /**`
	`116`	`+ * @return array`
	`117`	`+ */`
`115`	`118`	`public function pendingTransactionStatusesProvider()`
`116`	`119`	`{`
`117`	`120`	`return [`
`@@ -120,6 +123,9 @@ public function pendingTransactionStatusesProvider()`
`120`	`123`	`];`
`121`	`124`	`}`
`122`	`125`
	`126`	`+ /**`
	`127`	`+ * @return array`
	`128`	`+ */`
`123`	`129`	`public function declinedTransactionStatusesProvider()`
`124`	`130`	`{`
`125`	`131`	`return [`
Original file line number	Diff line number	Diff line change
`@@ -191,6 +191,9 @@ public function testIsExist($fileName, $fileMediaPath)`
`191`	`191`	`$this->assertTrue($this->model->isExist($fileName));`
`192`	`192`	`}`
`193`	`193`
	`194`	`+ /**`
	`195`	`+ * @return array`
	`196`	`+ */`
`194`	`197`	`public function isExistProvider()`
`195`	`198`	`{`
`196`	`199`	`return [`
`@@ -213,6 +216,9 @@ public function testIsBeginsWithMediaDirectoryPath($fileName, $expected)`
`213`	`216`	`$this->assertEquals($expected, $this->model->isBeginsWithMediaDirectoryPath($fileName));`
`214`	`217`	`}`
`215`	`218`
	`219`	`+ /**`
	`220`	`+ * @return array`
	`221`	`+ */`
`216`	`222`	`public function isBeginsWithMediaDirectoryPathProvider()`
`217`	`223`	`{`
`218`	`224`	`return [`
Original file line number	Diff line number	Diff line change
`@@ -486,6 +486,9 @@ public function testGetStoreSingleSiteModelIds(`
`486`	`486`	`$this->assertEquals($websiteIDs, $this->model->getStoreIds());`
`487`	`487`	`}`
`488`	`488`
	`489`	`+ /**`
	`490`	`+ * @return array`
	`491`	`+ */`
`489`	`492`	`public function getSingleStoreIds()`
`490`	`493`	`{`
`491`	`494`	`return [`
Original file line number	Diff line number	Diff line change
`@@ -48,6 +48,9 @@ public function testProcess($cartData, $expected)`
`48`	`48`	`$this->assertEquals($this->requestProcessor->process($cartData), $expected);`
`49`	`49`	`}`
`50`	`50`
	`51`	`+ /**`
	`52`	`+ * @return array`
	`53`	`+ */`
`51`	`54`	`public function cartDataProvider()`
`52`	`55`	`{`
`53`	`56`	`return [`
Original file line number	Diff line number	Diff line change
`@@ -640,6 +640,9 @@ public function testGetUnknownEntity($entity)`
`640`	`640`	`$import->getEntity();`
`641`	`641`	`}`
`642`	`642`
	`643`	`+ /**`
	`644`	`+ * @return array`
	`645`	`+ */`
`643`	`646`	`public function unknownEntitiesProvider()`
`644`	`647`	`{`
`645`	`648`	`return [`
Original file line number	Diff line number	Diff line change
`@@ -1253,6 +1253,9 @@ public function testGetCreatedAtFormattedUsesCorrectLocale()`
`1253`	`1253`	`$this->order->getCreatedAtFormatted(\IntlDateFormatter::SHORT);`
`1254`	`1254`	`}`
`1255`	`1255`
	`1256`	`+ /**`
	`1257`	`+ * @return array`
	`1258`	`+ */`
`1256`	`1259`	`public function notInvoicingStatesProvider()`
`1257`	`1260`	`{`
`1258`	`1261`	`return [`
`@@ -1262,6 +1265,9 @@ public function notInvoicingStatesProvider()`
`1262`	`1265`	`];`
`1263`	`1266`	`}`
`1264`	`1267`
	`1268`	`+ /**`
	`1269`	`+ * @return array`
	`1270`	`+ */`
`1265`	`1271`	`public function canNotCreditMemoStatesProvider()`
`1266`	`1272`	`{`
`1267`	`1273`	`return [`
Original file line number	Diff line number	Diff line change
`@@ -103,6 +103,9 @@ public function testCheck(`
`103`	`103`	`$this->assertEquals($expectedState, $this->orderMock->getState());`
`104`	`104`	`}`
`105`	`105`
	`106`	`+ /**`
	`107`	`+ * @return array`
	`108`	`+ */`
`106`	`109`	`public function stateCheckDataProvider()`
`107`	`110`	`{`
`108`	`111`	`return [`