MAGETWO-95259: CatalogSearch module deprecation must be reverted

Author: paliarush

app/code/Magento/CatalogSearch/Block/Advanced/Form.php

@@ -4,11 +4,6 @@
  * See COPYING.txt for license details.
  */
 
-/**
- * Advanced search form
- *
- * @author      Magento Core Team <core@magentocommerce.com>
- */
 namespace Magento\CatalogSearch\Block\Advanced;
 
 use Magento\CatalogSearch\Model\Advanced;
@@ -21,6 +16,8 @@
 use Magento\Framework\View\Element\Template\Context;
 
 /**
+ * Advanced search form
+ *
  * @api
  * @since 100.0.2
  */
@@ -58,7 +55,7 @@ public function __construct(
     }
 
     /**
-     * @return AbstractBlock
+     * @inheritdoc
      */
     public function _prepareLayout()
     {
@@ -286,6 +283,8 @@ public function getAttributeYesNoElement($attribute)
     }
 
     /**
+     * Get select block.
+     *
      * @return BlockInterface
      */
     protected function _getSelectBlock()
@@ -299,6 +298,8 @@ protected function _getSelectBlock()
     }
 
     /**
+     * Get date block.
+     *
      * @return BlockInterface|mixed
      */
     protected function _getDateBlock()

app/code/Magento/CatalogSearch/Block/Advanced/Result.php

@@ -63,7 +63,7 @@ public function __construct(
     }
 
     /**
-     * @return AbstractBlock
+     * @inheritdoc
      */
     protected function _prepareLayout()
     {
@@ -125,6 +125,8 @@ public function setListModes()
     }
 
     /**
+     * Initialize list collection.
+     *
      * @return void
      */
     public function setListCollection()
@@ -133,6 +135,8 @@ public function setListCollection()
     }
 
     /**
+     * Get product collection.
+     *
      * @return Collection
      */
     protected function _getProductCollection()
@@ -141,6 +145,8 @@ protected function _getProductCollection()
     }
 
     /**
+     * Set search model.
+     *
      * @return Advanced
      */
     public function getSearchModel()
@@ -149,6 +155,8 @@ public function getSearchModel()
     }
 
     /**
+     * Get result count.
+     *
      * @return mixed
      */
     public function getResultCount()
@@ -161,6 +169,8 @@ public function getResultCount()
     }
 
     /**
+     * Get product list HTML.
+     *
      * @return string
      */
     public function getProductListHtml()
@@ -169,6 +179,8 @@ public function getProductListHtml()
     }
 
     /**
+     * Get form URL.
+     *
      * @return string
      */
     public function getFormUrl()
@@ -182,6 +194,8 @@ public function getFormUrl()
     }
 
     /**
+     * Get search criteria.
+     *
      * @return array
      */
     public function getSearchCriterias()

app/code/Magento/CatalogSearch/Controller/Advanced/Index.php

@@ -10,10 +10,13 @@
 use Magento\Framework\App\Action\HttpPostActionInterface;
 use Magento\Framework\Controller\ResultFactory;
 
+/**
+ * Advanced search controller.
+ */
 class Index extends \Magento\Framework\App\Action\Action implements HttpGetActionInterface, HttpPostActionInterface
 {
     /**
-     * @return \Magento\Framework\Controller\ResultInterface
+     * @inheritdoc
      */
     public function execute()
     {

app/code/Magento/CatalogSearch/Controller/Advanced/Result.php

@@ -12,6 +12,9 @@
 use Magento\Framework\App\Action\HttpPostActionInterface;
 use Magento\Framework\UrlFactory;
 
+/**
+ * Advanced search result.
+ */
 class Result extends \Magento\Framework\App\Action\Action implements HttpGetActionInterface, HttpPostActionInterface
 {
     /**
@@ -46,7 +49,7 @@ public function __construct(
     }
 
     /**
-     * @return \Magento\Framework\Controller\Result\Redirect
+     * @inheritdoc
      */
     public function execute()
     {

app/code/Magento/CatalogSearch/Controller/Result/Index.php

@@ -15,6 +15,9 @@
 use Magento\Search\Model\QueryFactory;
 use Magento\Search\Model\PopularSearchTerms;
 
+/**
+ * Search result.
+ */
 class Index extends \Magento\Framework\App\Action\Action implements HttpGetActionInterface, HttpPostActionInterface
 {
     /**

app/code/Magento/CatalogSearch/Model/Adapter/Aggregation/Checker/Query/AdvancedSearch.php

@@ -29,7 +29,7 @@ public function __construct($name)
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function isApplicable(RequestInterface $request)
     {

app/code/Magento/CatalogSearch/Model/Adapter/Options.php

@@ -10,6 +10,8 @@
 use Magento\Store\Model\ScopeInterface;
 
 /**
+ * Catalog search config.
+ *
  * @api
  * @since 100.0.2
  */
@@ -33,7 +35,7 @@ public function __construct(ScopeConfigInterface $scopeConfig)
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function get()
     {

app/code/Magento/CatalogSearch/Model/Adminhtml/System/Config/Backend/Engine.php

@@ -6,6 +6,8 @@
 namespace Magento\CatalogSearch\Model\Adminhtml\System\Config\Backend;
 
 /**
+ * Backend model for catalog search engine system config
+ *
  * @api
  * @since 100.0.2
  */
@@ -42,6 +44,7 @@ public function __construct(
 
     /**
      * After save call
+     *
      * Invalidate catalog search index if engine was changed
      *
      * @return $this

app/code/Magento/CatalogSearch/Model/Advanced.php

@@ -22,6 +22,7 @@
 
 /**
  * Catalog advanced search model
+ *
  * @method int getEntityTypeId()
  * @method \Magento\CatalogSearch\Model\Advanced setEntityTypeId(int $value)
  * @method int getAttributeSetId()
@@ -296,6 +297,8 @@ public function prepareProductCollection($collection)
     }
 
     /**
+     * Add search criteria.
+     *
      * @param EntityAttribute $attribute
      * @param mixed $value
      * @return void

app/code/Magento/CatalogSearch/Model/Attribute/SearchWeight.php

@@ -7,8 +7,9 @@
 namespace Magento\CatalogSearch\Model\Attribute;
 
 /**
- * This plugin is responsible for processing of search_weight property of a product attribute,
- * which is used to boost matches by specific attributes.
+ * This plugin is responsible for processing of search_weight property of a product attribute.
+ *
+ * 'search_weight' is used to boost matches by specific attributes.
  *
  * This is part of search accuracy customization functionality.
  */

app/code/Magento/CatalogSearch/Model/Autocomplete/DataProvider.php

@@ -13,6 +13,9 @@
 use Magento\Framework\App\Config\ScopeConfigInterface as ScopeConfig;
 use Magento\Store\Model\ScopeInterface;
 
+/**
+ * Catalog search auto-complete data provider.
+ */
 class DataProvider implements DataProviderInterface
 {
     /**
@@ -44,6 +47,7 @@ class DataProvider implements DataProviderInterface
     /**
      * @param QueryFactory $queryFactory
      * @param ItemFactory $itemFactory
+     * @param ScopeConfig $scopeConfig
      */
     public function __construct(
         QueryFactory $queryFactory,
@@ -60,7 +64,7 @@ public function __construct(
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function getItems()
     {

app/code/Magento/CatalogSearch/Model/Indexer/Fulltext/Action/DataProvider.php

@@ -12,6 +12,8 @@
 use Magento\Store\Model\Store;
 
 /**
+ * Catalog search full test search data provider.
+ *
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  * @SuppressWarnings(PHPMD.TooManyFields)
  * @api

app/code/Magento/CatalogSearch/Model/Indexer/Fulltext/Plugin/Attribute.php

@@ -7,6 +7,9 @@
 
 use Magento\CatalogSearch\Model\Indexer\Fulltext;
 
+/**
+ * Catalog search indexer plugin for catalog attribute.
+ */
 class Attribute extends AbstractPlugin
 {
     /**

app/code/Magento/CatalogSearch/Model/Indexer/Fulltext/Plugin/Category.php

@@ -9,6 +9,9 @@
 use Magento\Catalog\Model\ResourceModel\Category as ResourceCategory;
 use Magento\Framework\Model\AbstractModel;
 
+/**
+ * Catalog search indexer plugin for catalog category.
+ */
 class Category extends AbstractPlugin
 {
     /**
@@ -26,6 +29,8 @@ public function aroundSave(ResourceCategory $resourceCategory, \Closure $proceed
     }
 
     /**
+     * Reindex catalog search.
+     *
      * @param ResourceCategory $resourceCategory
      * @param \Closure $proceed
      * @param AbstractModel $category

app/code/Magento/CatalogSearch/Model/Indexer/Fulltext/Plugin/Product.php

@@ -9,9 +9,14 @@
 use Magento\Catalog\Model\ResourceModel\Product as ResourceProduct;
 use Magento\Framework\Model\AbstractModel;
 
+/**
+ * Catalog search indexer plugin for catalog product.
+ */
 class Product extends AbstractPlugin
 {
     /**
+     * Reindex on product save.
+     *
      * @param ResourceProduct $productResource
      * @param \Closure $proceed
      * @param AbstractModel $product
@@ -38,6 +43,8 @@ public function aroundDelete(ResourceProduct $productResource, \Closure $proceed
     }
 
     /**
+     * Reindex catalog search.
+     *
      * @param ResourceProduct $productResource
      * @param \Closure $proceed
      * @param AbstractModel $product

app/code/Magento/CatalogSearch/Model/Indexer/Fulltext/Store.php

@@ -11,6 +11,9 @@
 use Magento\Framework\Indexer\ConfigInterface;
 use Magento\Framework\Event\ObserverInterface;
 
+/**
+ * Catalog search indexer plugin for store.
+ */
 class Store implements ObserverInterface
 {
     /**
@@ -44,6 +47,8 @@ public function __construct(
     }
 
     /**
+     * Reindex catalog search.
+     *
      * @param \Magento\Store\Model\Store $store
      * @return void
      */
@@ -59,6 +64,8 @@ private function clearIndex(\Magento\Store\Model\Store $store)
     }
 
     /**
+     * Reindex catalog search on store modification.
+     *
      * @param \Magento\Framework\Event\Observer $observer
      * @return void
      */

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

@@ -10,6 +10,8 @@
 use Magento\Framework\Search\EngineResolverInterface;
 
 /**
+ * Index structure factory
+ *
  * @api
  * @since 100.1.0
  */

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

@@ -10,6 +10,8 @@
 use Magento\Framework\Search\EngineResolverInterface;
 
 /**
+ * Indexer handler factory.
+ *
  * @api
  * @since 100.0.2
  */

app/code/Magento/CatalogSearch/Model/Indexer/Mview/Action.php

@@ -9,6 +9,9 @@
 use Magento\Framework\Mview\ActionInterface;
 use Magento\Framework\Indexer\IndexerInterfaceFactory;
 
+/**
+ * Catalog search materialized view index action.
+ */
 class Action implements ActionInterface
 {
     /**