magento-engcom/magento2ce#2169: fix coding style

Author: Stanislav Idolov

app/code/Magento/Backend/Block/Media/Uploader.php

@@ -65,6 +65,8 @@ public function __construct(
     }
 
     /**
+     * Initialize block.
+     *
      * @return void
      */
     protected function _construct()

app/code/Magento/Catalog/Block/Adminhtml/Product/Helper/Form/Gallery.php

@@ -18,6 +18,9 @@
 use Magento\Eav\Model\Entity\Attribute;
 use Magento\Catalog\Api\Data\ProductInterface;
 
+/**
+ * Adminhtml gallery block
+ */
 class Gallery extends \Magento\Framework\View\Element\AbstractBlock
 {
     /**
@@ -79,6 +82,7 @@ class Gallery extends \Magento\Framework\View\Element\AbstractBlock
      * @param Registry $registry
      * @param \Magento\Framework\Data\Form $form
      * @param array $data
+     * @param DataPersistorInterface|null $dataPersistor
      */
     public function __construct(
         \Magento\Framework\View\Element\Context $context,
@@ -96,6 +100,8 @@ public function __construct(
     }
 
     /**
+     * Returns element html.
+     *
      * @return string
      */
     public function getElementHtml()
@@ -148,6 +154,8 @@ public function getContentHtml()
     }
 
     /**
+     * Returns html id
+     *
      * @return string
      */
     protected function getHtmlId()
@@ -156,6 +164,8 @@ protected function getHtmlId()
     }
 
     /**
+     * Returns name
+     *
      * @return string
      */
     public function getName()
@@ -164,6 +174,8 @@ public function getName()
     }
 
     /**
+     * Returns suffix for field name
+     *
      * @return string
      */
     public function getFieldNameSuffix()
@@ -172,6 +184,8 @@ public function getFieldNameSuffix()
     }
 
     /**
+     * Returns data scope html id
+     *
      * @return string
      */
     public function getDataScopeHtmlId()
@@ -256,7 +270,6 @@ public function getDataObject()
     /**
      * Retrieve attribute field name
      *
-     *
      * @param Attribute $attribute
      * @return string
      */
@@ -270,6 +283,8 @@ public function getAttributeFieldName($attribute)
     }
 
     /**
+     * Returns html content of the block
+     *
      * @return string
      */
     public function toHtml()

app/code/Magento/Catalog/Block/Adminhtml/Product/Helper/Form/Gallery/Content.php

@@ -18,6 +18,9 @@
 use Magento\Framework\App\Filesystem\DirectoryList;
 use Magento\Framework\Exception\FileSystemException;
 
+/**
+ * Block for gallery content.
+ */
 class Content extends \Magento\Backend\Block\Widget
 {
     /**
@@ -58,6 +61,8 @@ public function __construct(
     }
 
     /**
+     * Prepare layout.
+     *
      * @return AbstractBlock
      */
     protected function _prepareLayout()
@@ -103,6 +108,8 @@ public function getUploaderHtml()
     }
 
     /**
+     * Returns js object name
+     *
      * @return string
      */
     public function getJsObjectName()
@@ -111,6 +118,8 @@ public function getJsObjectName()
     }
 
     /**
+     * Returns buttons for add image action.
+     *
      * @return string
      */
     public function getAddImagesButton()
@@ -124,6 +133,8 @@ public function getAddImagesButton()
     }
 
     /**
+     * Returns image json
+     *
      * @return string
      */
     public function getImagesJson()
@@ -169,6 +180,8 @@ private function sortImagesByPosition($images)
     }
 
     /**
+     * Returns image values json
+     *
      * @return string
      */
     public function getImagesValuesJson()
@@ -243,6 +256,8 @@ public function getImageTypesJson()
     }
 
     /**
+     * Returns image helper object.
+     *
      * @return \Magento\Catalog\Helper\Image
      * @deprecated 101.0.3
      */

app/code/Magento/CatalogSearch/Model/Indexer/IndexerHandler.php

@@ -14,6 +14,8 @@
 use Magento\Framework\Indexer\SaveHandler\Batch;
 
 /**
+ * Catalog search indexer handler.
+ *
  * @api
  * @since 100.0.2
  * @deprecated CatalogSearch will be removed in 2.4, and {@see \Magento\ElasticSearch}
@@ -92,7 +94,7 @@ public function __construct(
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function saveIndex($dimensions, \Traversable $documents)
     {
@@ -102,7 +104,7 @@ public function saveIndex($dimensions, \Traversable $documents)
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function deleteIndex($dimensions, \Traversable $documents)
     {
@@ -113,7 +115,7 @@ public function deleteIndex($dimensions, \Traversable $documents)
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function cleanIndex($dimensions)
     {
@@ -122,7 +124,7 @@ public function cleanIndex($dimensions)
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function isAvailable($dimensions = [])
     {
@@ -134,6 +136,8 @@ public function isAvailable($dimensions = [])
     }
 
     /**
+     * Returns table name.
+     *
      * @param Dimension[] $dimensions
      * @return string
      */
@@ -143,6 +147,8 @@ private function getTableName($dimensions)
     }
 
     /**
+     * Returns index name.
+     *
      * @return string
      */
     private function getIndexName()
@@ -151,6 +157,8 @@ private function getIndexName()
     }
 
     /**
+     * Add documents to storage.
+     *
      * @param array $documents
      * @param Dimension[] $dimensions
      * @return void
@@ -169,6 +177,8 @@ private function insertDocuments(array $documents, array $dimensions)
     }
 
     /**
+     * Searchable filter preparation.
+     *
      * @param array $documents
      * @return array
      */
@@ -189,6 +199,8 @@ private function prepareSearchableFields(array $documents)
     }
 
     /**
+     * Prepare fields.
+     *
      * @return void
      */
     private function prepareFields()

app/code/Magento/Elasticsearch/Model/Indexer/IndexerHandler.php

@@ -12,6 +12,9 @@
 use Magento\Elasticsearch\Model\Adapter\Index\IndexNameResolver;
 use Magento\Framework\App\ScopeResolverInterface;
 
+/**
+ * Indexer Handler for Elasticsearch engine.
+ */
 class IndexerHandler implements IndexerInterface
 {
     /**
@@ -82,7 +85,7 @@ public function __construct(
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function saveIndex($dimensions, \Traversable $documents)
     {
@@ -97,7 +100,7 @@ public function saveIndex($dimensions, \Traversable $documents)
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function deleteIndex($dimensions, \Traversable $documents)
     {
@@ -112,7 +115,7 @@ public function deleteIndex($dimensions, \Traversable $documents)
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function cleanIndex($dimensions)
     {
@@ -122,14 +125,16 @@ public function cleanIndex($dimensions)
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function isAvailable($dimensions = [])
     {
         return $this->adapter->ping();
     }
 
     /**
+     * Returns indexer id.
+     *
      * @return string
      */
     private function getIndexerId()

lib/internal/Magento/Framework/File/Uploader.php

@@ -191,8 +191,7 @@ protected function _afterSave($result)
     }
 
     /**
-     * Used to save uploaded file into destination folder with
-     * original or new file name (if specified)
+     * Used to save uploaded file into destination folder with original or new file name (if specified)
      *
      * @param string $destinationFolder
      * @param string $newFileName
@@ -269,6 +268,8 @@ private function validateDestination($destinationFolder)
     }
 
     /**
+     * Set 0777 rights for the file.
+     *
      * @param string $file
      * @return void
      *

lib/internal/Magento/Framework/Image/Adapter/Config.php

@@ -7,6 +7,9 @@
 
 namespace Magento\Framework\Image\Adapter;
 
+/**
+ * Image config provider.
+ */
 class Config implements ConfigInterface, UploadConfigInterface
 {
     const XML_PATH_IMAGE_ADAPTER = 'dev/image/default_adapter';