magento-engcom/magento2ce#2306: Code style fixes

Author: Stanislav Idolov

app/code/Magento/CatalogImportExport/Model/Import/Uploader.php

@@ -101,7 +101,7 @@ class Uploader extends \Magento\MediaStorage\Model\File\Uploader
      * @param \Magento\MediaStorage\Model\File\Validator\NotProtectedExtension $validator
      * @param \Magento\Framework\Filesystem $filesystem
      * @param \Magento\Framework\Filesystem\File\ReadFactory $readFactory
-     * @param null $filePath
+     * @param null|string $filePath
      * @throws \Magento\Framework\Exception\LocalizedException
      */
     public function __construct(
@@ -353,7 +353,7 @@ protected function _moveFile($tmpPath, $destPath)
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     protected function chmod($file)
     {

app/code/Magento/Customer/Block/Adminhtml/Edit/Tab/Orders.php

@@ -57,7 +57,7 @@ public function __construct(
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     protected function _construct()
     {
@@ -102,7 +102,7 @@ protected function _prepareCollection()
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     protected function _prepareColumns()
     {
@@ -163,7 +163,7 @@ public function getRowUrl($row)
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function getGridUrl()
     {

app/code/Magento/Customer/Controller/Account/ForgotPassword.php

@@ -1,6 +1,5 @@
 <?php
 /**
- *
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
@@ -11,6 +10,9 @@
 use Magento\Framework\App\Action\Context;
 use Magento\Framework\View\Result\PageFactory;
 
+/**
+ * Forgot Password controller
+ */
 class ForgotPassword extends \Magento\Customer\Controller\AbstractAccount implements HttpGetActionInterface
 {
     /**

app/code/Magento/Swatches/Helper/Data.php

@@ -132,6 +132,8 @@ public function __construct(
     }
 
     /**
+     * Assemble Additional Data for Eav Attribute
+     *
      * @param Attribute $attribute
      * @return $this
      */
@@ -181,6 +183,8 @@ private function isMediaAvailable(ModelProduct $product, string $attributeCode):
     }
 
     /**
+     * Load first variation
+     *
      * @param string $attributeCode swatch_image|image
      * @param ModelProduct $configurableProduct
      * @param array $requiredAttributes
@@ -204,6 +208,8 @@ private function loadFirstVariation($attributeCode, ModelProduct $configurablePr
     }
 
     /**
+     * Load first variation with swatch image
+     *
      * @param Product $configurableProduct
      * @param array $requiredAttributes
      * @return bool|Product
@@ -214,6 +220,8 @@ public function loadFirstVariationWithSwatchImage(Product $configurableProduct,
     }
 
     /**
+     * Load first variation with image
+     *
      * @param Product $configurableProduct
      * @param array $requiredAttributes
      * @return bool|Product
@@ -269,6 +277,8 @@ public function loadVariationByFallback(Product $parentProduct, array $attribute
     }
 
     /**
+     * Add filter by attribute
+     *
      * @param ProductCollection $productCollection
      * @param array $attributes
      * @return void
@@ -281,6 +291,8 @@ private function addFilterByAttributes(ProductCollection $productCollection, arr
     }
 
     /**
+     * Add filter by parent
+     *
      * @param ProductCollection $productCollection
      * @param integer $parentId
      * @return void
@@ -299,6 +311,7 @@ private function addFilterByParent(ProductCollection $productCollection, $parent
 
     /**
      * Method getting full media gallery for current Product
+     *
      * Array structure: [
      *  ['image'] => 'http://url/pub/media/catalog/product/2/0/blabla.jpg',
      *  ['mediaGallery'] => [
@@ -307,7 +320,9 @@ private function addFilterByParent(ProductCollection $productCollection, $parent
      *      ...,
      *      ]
      * ]
+     *
      * @param ModelProduct $product
+     *
      * @return array
      */
     public function getProductMediaGallery(ModelProduct $product)
@@ -339,6 +354,8 @@ public function getProductMediaGallery(ModelProduct $product)
     }
 
     /**
+     * Get all size images
+     *
      * @param string $imageFile
      * @return array
      */
@@ -476,6 +493,8 @@ private function setCachedSwatches(array $optionIds, array $swatches)
     }
 
     /**
+     * Add fallback options
+     *
      * @param array $fallbackValues
      * @param array $swatches
      * @return array

lib/internal/Magento/Framework/Cache/Backend/Memcached.php

@@ -5,6 +5,9 @@
  */
 namespace Magento\Framework\Cache\Backend;
 
+/**
+ * Memcached cache model
+ */
 class Memcached extends \Zend_Cache_Backend_Memcached implements \Zend_Cache_Backend_ExtendedInterface
 {
     /**
@@ -46,7 +49,7 @@ public function __construct(array $options = [])
      * Returns ID of a specific chunk on the basis of data's ID
      *
      * @param string $id    Main data's ID
-     * @param int    $index Particular chunk number to return ID for
+     * @param int $index Particular chunk number to return ID for
      * @return string
      */
     protected function _getChunkId($id, $index)
@@ -58,7 +61,7 @@ protected function _getChunkId($id, $index)
      * Remove saved chunks in case something gone wrong (e.g. some chunk from the chain can not be found)
      *
      * @param string $id     ID of data's info cell
-     * @param int    $chunks Number of chunks to remove (basically, the number after '{splitted}|')
+     * @param int $chunks Number of chunks to remove (basically, the number after '{splitted}|')
      * @return null
      */
     protected function _cleanTheMess($id, $chunks)
@@ -103,7 +106,7 @@ public function save($data, $id, $tags = [], $specificLifetime = false)
      * Load data from memcached, glue from several chunks if it was splitted upon save.
      *
      * @param string $id                     @see \Zend_Cache_Backend_Memcached::load()
-     * @param bool   $doNotTestCacheValidity @see \Zend_Cache_Backend_Memcached::load()
+     * @param bool $doNotTestCacheValidity @see \Zend_Cache_Backend_Memcached::load()
      * @return bool|false|string
      */
     public function load($id, $doNotTestCacheValidity = false)

lib/internal/Magento/Framework/Filter/Template.php

@@ -10,6 +10,8 @@
 namespace Magento\Framework\Filter;
 
 /**
+ * Template filter
+ *
  * @api
  */
 class Template implements \Zend_Filter_Interface
@@ -228,8 +230,9 @@ protected function afterFilter($value)
     }
 
     /**
-     * Adds a callback to run after main filtering has happened. Callback must accept a single argument and return
-     * a string of the processed value.
+     * Adds a callback to run after main filtering has happened.
+     *
+     * Callback must accept a single argument and return a string of the processed value.
      *
      * @param callable $afterFilterCallback
      * @return $this
@@ -257,6 +260,8 @@ protected function resetAfterFilterCallbacks()
     }
 
     /**
+     * Get var directive
+     *
      * @param string[] $construction
      * @return string
      */
@@ -302,6 +307,8 @@ public function templateDirective($construction)
     }
 
     /**
+     * Get depend directive
+     *
      * @param string[] $construction
      * @return string
      */
@@ -320,6 +327,8 @@ public function dependDirective($construction)
     }
 
     /**
+     * If directive
+     *
      * @param string[] $construction
      * @return string
      */

setup/src/Magento/Setup/Module/I18n/Parser/Adapter/Html.php

@@ -20,7 +20,7 @@ class Html extends AbstractAdapter
     const HTML_FILTER = "/i18n:\s?'(?<value>[^'\\\\]*(?:\\\\.[^'\\\\]*)*)'/i";
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     protected function _parse()
     {

setup/src/Magento/Setup/Module/I18n/Parser/Adapter/Js.php

@@ -11,7 +11,7 @@
 class Js extends AbstractAdapter
 {
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     protected function _parse()
     {