Merge pull request #820 from magento-falcons/MAGETWO-64335

Task
- MAGETWO-63764 [TD] Fix exceptions in Scope/Validator
- MAGETWO-63216 [TD] Fix PHPDoc comments that was delivered in Sprint 4

Author: VladimirZaets

app/code/Magento/Backend/Block/Template.php

@@ -63,14 +63,14 @@ public function getFormKey()
     }
 
     /**
-     * Check whether or not the module output is enabled
+     * Check whether or not the module output is enabled.
      *
      * Because many module blocks belong to Backend module,
-     * the feature "Disable module output" doesn't cover Admin area
+     * the feature "Disable module output" doesn't cover Admin area.
      *
      * @param string $moduleName Full module name
      * @return boolean
-     * @deprecated
+     * @deprecated Magento does not support custom disabling/enabling module output since 2.2.0 version
      * @SuppressWarnings(PHPMD.UnusedFormalParameter)
      */
     public function isOutputEnabled($moduleName = null)

app/code/Magento/Backend/etc/adminhtml/system.xml

@@ -16,6 +16,10 @@
         <tab id="advanced" translate="label" sortOrder="999999">
             <label>Advanced</label>
         </tab>
+        <!--
+        @deprecated Magento does not support custom disabling/enabling modules output since 2.2.0 version.
+        Section 'Advanced' was disabled. This section will be removed from code in one release.
+        -->
         <section id="advanced" translate="label" type="text" sortOrder="910" showInDefault="0" showInWebsite="0" showInStore="0">
             <label>Advanced</label>
             <tab>advanced</tab>

app/code/Magento/Catalog/Test/Unit/Block/Adminhtml/Product/Options/AjaxTest.php

@@ -31,6 +31,9 @@ class AjaxTest extends \PHPUnit_Framework_TestCase
     /** @var \Magento\Framework\Registry|\PHPUnit_Framework_MockObject_MockObject */
     protected $registry;
 
+    /**
+     * @inheritdoc
+     */
     protected function setUp()
     {
         $this->context = $this->getMockBuilder(\Magento\Backend\Block\Context::class)

app/code/Magento/Catalog/Test/Unit/Block/Product/Widget/NewWidgetTest.php

@@ -52,6 +52,9 @@ class NewWidgetTest extends \PHPUnit_Framework_TestCase
     /** @var \Magento\Catalog\Model\ResourceModel\Product\Collection|\PHPUnit_Framework_MockObject_MockObject */
     protected $productCollection;
 
+    /**
+     * @inheritdoc
+     */
     protected function setUp()
     {
         $this->objectManager = new ObjectManagerHelper($this);
@@ -109,6 +112,9 @@ protected function setUp()
         );
     }
 
+    /**
+     * @inheritdoc
+     */
     protected function tearDown()
     {
         $this->block = null;
@@ -168,6 +174,9 @@ public function testGetCurrentPage($pageNumber, $expectedResult)
         $this->assertEquals($expectedResult, $this->block->getCurrentPage());
     }
 
+    /**
+     * @return array
+     */
     public function getCurrentPageDataProvider()
     {
         return [
@@ -184,6 +193,9 @@ public function testGetProductsCount()
         $this->assertEquals(2, $this->block->getProductsCount());
     }
 
+    /**
+     * @return void
+     */
     protected function generalGetProductCollection()
     {
         $this->eventManager->expects($this->exactly(2))->method('dispatch')
@@ -327,6 +339,9 @@ public function testGetProductAllCollection($pagerEnable, $productsCount, $produ
         );
     }
 
+    /**
+     * @return array
+     */
     public function getProductCollectionDataProvider()
     {
         return [

app/code/Magento/Checkout/Test/Unit/Block/Cart/Item/Renderer/ActionsTest.php

@@ -26,6 +26,9 @@ class ActionsTest extends \PHPUnit_Framework_TestCase
      */
     protected $layoutMock;
 
+    /**
+     * @inheritdoc
+     */
     protected function setUp()
     {
         $objectManagerHelper = new \Magento\Framework\TestFramework\Unit\Helper\ObjectManager($this);

app/code/Magento/Config/Block/System/Config/Form/Fieldset/Modules/DisableOutput.php

@@ -3,34 +3,38 @@
  * Copyright © 2013-2017 Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
-
-/**
- * @method \Magento\Config\Block\System\Config\Form getForm()
- */
 namespace Magento\Config\Block\System\Config\Form\Fieldset\Modules;
 
 /**
- * @deprecated
+ * Displays a list of <select> tags with names of the modules on tab Stores > Configuration > Advanced / Advanced
+ * on the store settings page.
+ *
+ * @method \Magento\Config\Block\System\Config\Form getForm()
+ * @deprecated Magento does not support custom disabling/enabling module output since 2.2.0 version
  */
 class DisableOutput extends \Magento\Config\Block\System\Config\Form\Fieldset
 {
     /**
      * @var \Magento\Framework\DataObject
+     * @deprecated Magento does not support custom disabling/enabling module output since 2.2.0 version
      */
     protected $_dummyElement;
 
     /**
      * @var \Magento\Config\Block\System\Config\Form\Field
+     * @deprecated Magento does not support custom disabling/enabling module output since 2.2.0 version
      */
     protected $_fieldRenderer;
 
     /**
      * @var array
+     * @deprecated Magento does not support custom disabling/enabling module output since 2.2.0 version
      */
     protected $_values;
 
     /**
      * @var \Magento\Framework\Module\ModuleListInterface
+     * @deprecated Magento does not support custom disabling/enabling module output since 2.2.0 version
      */
     protected $_moduleList;
 
@@ -53,8 +57,8 @@ public function __construct(
     }
 
     /**
-     * @param \Magento\Framework\Data\Form\Element\AbstractElement $element
-     * @return string
+     * {@inheritdoc}
+     * @deprecated Magento does not support custom disabling/enabling module output since 2.2.0 version
      */
     public function render(\Magento\Framework\Data\Form\Element\AbstractElement $element)
     {
@@ -83,6 +87,7 @@ public function render(\Magento\Framework\Data\Form\Element\AbstractElement $ele
     }
 
     /**
+     * @deprecated Magento does not support custom disabling/enabling module output since 2.2.0 version
      * @return \Magento\Framework\DataObject
      */
     protected function _getDummyElement()
@@ -94,6 +99,7 @@ protected function _getDummyElement()
     }
 
     /**
+     * @deprecated Magento does not support custom disabling/enabling module output since 2.2.0 version
      * @return \Magento\Config\Block\System\Config\Form\Field
      */
     protected function _getFieldRenderer()
@@ -107,6 +113,7 @@ protected function _getFieldRenderer()
     }
 
     /**
+     * @deprecated Magento does not support custom disabling/enabling module output since 2.2.0 version
      * @return array
      */
     protected function _getValues()
@@ -123,6 +130,7 @@ protected function _getValues()
     /**
      * @param \Magento\Framework\Data\Form\Element\Fieldset $fieldset
      * @param string $moduleName
+     * @deprecated Magento does not support custom disabling/enabling module output since 2.2.0 version
      * @return mixed
      */
     protected function _getFieldHtml($fieldset, $moduleName)

app/code/Magento/Config/Model/Config/Parser/Comment.php

@@ -14,7 +14,10 @@
 use Magento\Framework\Filesystem;
 
 /**
- * Class Comment. It is used to parse config paths from comment section.
+ * Config file parser
+ *
+ * It is used to parse config paths from
+ * comment section in provided configuration file.
  */
 class Comment implements CommentParserInterface
 {
@@ -41,17 +44,43 @@ public function __construct(
     }
 
     /**
-     * Retrieves config paths from comment section of the file.
-     * Example of comment:
-     *        * CONFIG__DEFAULT__SOME__CONF__PATH_ONE
-     *        * CONFIG__DEFAULT__SOME__CONF__PATH_TWO
-     * This method will return:
-     *        array(
-     *            'CONFIG__DEFAULT__SOME__CONF__PATH_ONE' => 'some/conf/path_one',
-     *            'CONFIG__DEFAULT__SOME__CONF__PATH_TWO' => 'some/conf/path_two'
-     *        );
+     * Retrieves config array paths from comment section of the config file
      *
-     * @param string $fileName
+     * Example:
+     * some.file.config.php file is located in the directory /<root_app_dir>/app/etc/
+     * File Content some.file.config.php
+     * ```php
+     * return [
+     *  'scopes' => [
+     *      //...
+     *  ],
+     * // ...
+     * // The configuration file doesn't contain sensitive data for security reasons.
+     * // Sensitive data can be stored in the following environment variables:
+     * // CONFIG__DEFAULT__SOME__CONF__PATH_ONE for some/conf/path_one
+     *  'system' => [],
+     * // ...
+     * // CONFIG__DEFAULT__SOME__CONF__PATH_TWO for some/conf/path_two
+     * // ...
+     * ];
+     *  ```
+     * Usage:
+     * ```php
+     * // ...
+     * // $commentParser variable contains an object of type \Magento\Config\Model\Config\Parser\Comment
+     * $fileName = 'some.file.config.php';
+     * $result = $commentParser->execute($fileName);
+     * // ...
+     * ```
+     * The variable $result will be set to
+     * ```php
+     * array(
+     *     'CONFIG__DEFAULT__SOME__CONF__PATH_ONE' => 'some/conf/path_one',
+     *     'CONFIG__DEFAULT__SOME__CONF__PATH_TWO' => 'some/conf/path_two'
+     * );
+     * ```
+     *
+     * @param string $fileName the basename of file
      * @return array
      * @throws FileSystemException
      */

app/code/Magento/Config/Test/Unit/Block/System/Config/Form/Fieldset/Modules/DisableOutputTest.php

@@ -7,7 +7,7 @@
 
 /**
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
- * @deprecated
+ * @deprecated because \Magento\Config\Block\System\Config\Form\Fieldset\Modules\DisableOutput is deprecated
  */
 class DisableOutputTest extends \PHPUnit_Framework_TestCase
 {

app/code/Magento/Config/Test/Unit/Model/Config/Parser/CommentTest.php

@@ -29,6 +29,9 @@ class CommentTest extends \PHPUnit_Framework_TestCase
      */
     private $model;
 
+    /**
+     * @inheritdoc
+     */
     protected function setUp()
     {
         $this->placeholderMock = $this->getMockBuilder(PlaceholderInterface::class)

app/code/Magento/Deploy/Console/Command/App/SensitiveConfigSet/CollectorFactory.php

@@ -32,7 +32,8 @@ class CollectorFactory
 
     /**
      * @param ObjectManagerInterface $objectManager
-     * @param array $types
+     * @param array $types list of collector class names this factory can create.
+     * Every class should implement \Magento\Deploy\Console\Command\App\SensitiveConfigSet\CollectorInterface
      */
     public function __construct(
         ObjectManagerInterface $objectManager,
@@ -43,7 +44,12 @@ public function __construct(
     }
 
     /**
-     * Create instance of CollectorInterface by given type.
+     * Creates instance of CollectorInterface by given type.
+     *
+     * The value of the $type associated with the name of the class of collector object to create
+     * There are several types of collectors
+     * @see \Magento\Deploy\Console\Command\App\SensitiveConfigSet\InteractiveCollector
+     * @see \Magento\Deploy\Console\Command\App\SensitiveConfigSet\SimpleCollector
      *
      * @param string $type
      * @return CollectorInterface