MAGETWO-63216: [TD] Fix PHPDoc comments that was delivered in Sprint 4

Yevhen Miroshnychenko · Yevhen Miroshnychenko · commit d33034b3f407 · 2017-01-30T15:02:47.000+02:00
diff --git a/app/code/Magento/Backend/Block/Template.php b/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 because there are tools to change the module state in the admin panel and magento 2 CLI.
+     * @deprecated was removed from Magento
      * @SuppressWarnings(PHPMD.UnusedFormalParameter)
      */
     public function isOutputEnabled($moduleName = null)
diff --git a/app/code/Magento/Backend/etc/adminhtml/system.xml b/app/code/Magento/Backend/etc/adminhtml/system.xml
@@ -1,8 +1,6 @@
 <?xml version="1.0"?>
 <!--
 /**
- * The module configuration file of Magento_Backend
- *
  * Copyright © 2013-2017 Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
diff --git a/app/code/Magento/Config/Block/System/Config/Form/Fieldset/Modules/DisableOutput.php b/app/code/Magento/Config/Block/System/Config/Form/Fieldset/Modules/DisableOutput.php
@@ -6,11 +6,11 @@
 namespace Magento\Config\Block\System\Config\Form\Fieldset\Modules;
 
 /**
- * It displays a list of the inputs with names of the modules on tab Store->Configuration Advanced/Advanced
- * on the store settings page
+ * Displays a list of the inputs with names of the modules on tab Store->Configuration Advanced/Advanced
+ * on the store settings page.
  *
  * @method \Magento\Config\Block\System\Config\Form getForm()
- * @deprecated because there are tools to change the module state in the admin panel and magento 2 CLI.
+ * @deprecated was removed from Magento
  */
 class DisableOutput extends \Magento\Config\Block\System\Config\Form\Fieldset
 {
diff --git a/app/code/Magento/Config/Model/Config/Parser/Comment.php b/app/code/Magento/Config/Model/Config/Parser/Comment.php
@@ -80,7 +80,7 @@ public function __construct(
      * );
      * ```
      *
-     * @param string $fileName only basename
+     * @param string $fileName the basename of file
      * @return array
      * @throws FileSystemException
      */
diff --git a/app/code/Magento/Deploy/Console/Command/App/SensitiveConfigSet/CollectorInterface.php b/app/code/Magento/Deploy/Console/Command/App/SensitiveConfigSet/CollectorInterface.php
@@ -10,17 +10,25 @@
 use Symfony\Component\Console\Output\OutputInterface;
 
 /**
- * Interface for collection values from user input
+ * Interface for collection values from user input.
  */
 interface CollectorInterface
 {
     /**
-     * Collects values from user input and return result as array
+     * Collects values from user input and return result as array.
      *
      * @param InputInterface $input
      * @param OutputInterface $output
      * @param array $configPaths list of available config paths
-     * @return array
+     * @return array for example
+     *
+     * ```php
+     * [
+     *     'some/configuration/path1' => 'someValue1',
+     *     'some/configuration/path2' => 'someValue2',
+     *     'some/configuration/path3' => 'someValue3',
+     * ]
+     * ```
      * @throws LocalizedException
      */
     public function getValues(InputInterface $input, OutputInterface $output, array $configPaths);
diff --git a/app/code/Magento/Deploy/Model/Filesystem.php b/app/code/Magento/Deploy/Model/Filesystem.php
@@ -23,9 +23,9 @@ class Filesystem
      * File access permissions
      *
      * @deprecated As magento2 doesn't control indirectly the access permissions to the files anymore.
-     *             Access permissions to the files are set during deploy Magento 2, directly after
-     *             uploading code of Magento. Also it is possible to specify the value
-     *             of inverse mask for setting access permissions to files generated by Magento.
+     * Access permissions to the files are set during deploy Magento 2, directly after
+     * uploading code of Magento. Also it is possible to specify the value
+     * of inverse mask for setting access permissions to files generated by Magento.
      * @see http://devdocs.magento.com/guides/v2.0/install-gde/install/post-install-umask.html.
      * @see http://devdocs.magento.com/guides/v2.0/install-gde/prereq/file-system-perms.html}.
      */
@@ -35,9 +35,9 @@ class Filesystem
      * Directory access permissions
      *
      * @deprecated As magento2 doesn't control indirectly the access permissions to the directories anymore.
-     *             Access permissions to the directories are set during deploy Magento 2, directly after
-     *             uploading code of Magento. Also it is possible to specify the value
-     *             of inverse mask for setting access permissions to directories generated by Magento.
+     * Access permissions to the directories are set during deploy Magento 2, directly after
+     * uploading code of Magento. Also it is possible to specify the value
+     * of inverse mask for setting access permissions to directories generated by Magento.
      * @see http://devdocs.magento.com/guides/v2.0/install-gde/install/post-install-umask.html umask
      * @see http://devdocs.magento.com/guides/v2.0/install-gde/prereq/file-system-perms.html}
      */
@@ -215,8 +215,8 @@ private function getUsedLocales()
      *
      * @return UserCollection
      * @deprecated Added to not break backward compatibility of the constructor signature
-     *             by injecting the new dependency directly.
-     *             The method can be removed in a future major release, when constructor signature can be changed
+     * by injecting the new dependency directly.
+     * The method can be removed in a future major release, when constructor signature can be changed.
      */
     private function getUserCollection()
     {
@@ -298,16 +298,16 @@ public function cleanupFilesystem($directoryCodeList)
     }
 
     /**
-     * Change permissions for directories by their code
+     * Changes permissions for directories by their code.
      *
      * @param array $directoryCodeList
      * @param int $dirPermissions
      * @param int $filePermissions
      * @return void
      * @deprecated As magento2 doesn't control indirectly the access permissions to the files and directories anymore.
-     *             Access permissions to the files and directories are set during deploy Magento 2, directly after
-     *             uploading code of Magento. Also it is possible to specify the value
-     *             of inverse mask for setting access permissions to files and directories generated by Magento.
+     * Access permissions to the files and directories are set during deploy Magento 2, directly after
+     * uploading code of Magento. Also it is possible to specify the value
+     * of inverse mask for setting access permissions to files and directories generated by Magento.
      * @see http://devdocs.magento.com/guides/v2.0/install-gde/install/post-install-umask.html
      * @see http://devdocs.magento.com/guides/v2.0/install-gde/prereq/file-system-perms.html}
      */
@@ -329,9 +329,9 @@ protected function changePermissions($directoryCodeList, $dirPermissions, $fileP
      *
      * @return void
      * @deprecated As magento2 doesn't control indirectly the access permissions to the files and directories anymore.
-     *             Access permissions to the files and directories are set during deploy Magento 2, directly after
-     *             uploading code of Magento. Also it is possible to specify the value
-     *             of inverse mask for setting access permissions to files and directories generated by Magento.
+     * Access permissions to the files and directories are set during deploy Magento 2, directly after
+     * uploading code of Magento. Also it is possible to specify the value
+     * of inverse mask for setting access permissions to files and directories generated by Magento.
      * @see http://devdocs.magento.com/guides/v2.0/install-gde/install/post-install-umask.html
      * @see http://devdocs.magento.com/guides/v2.0/install-gde/prereq/file-system-perms.html}
      */
diff --git a/lib/internal/Magento/Framework/App/Config/CommentParserInterface.php b/lib/internal/Magento/Framework/App/Config/CommentParserInterface.php
@@ -8,7 +8,7 @@
 use Magento\Framework\Exception\FileSystemException;
 
 /**
- * Interface of comments parser in the config file
+ * Interface for parsing comments in the configuration file.
  */
 interface CommentParserInterface
 {
diff --git a/lib/internal/Magento/Framework/Code/Generator/Io.php b/lib/internal/Magento/Framework/Code/Generator/Io.php
@@ -8,7 +8,7 @@
 use Magento\Framework\Exception\FileSystemException;
 
 /**
- * Writes the generated code
+ * Manages generated code.
  */
 class Io
 {
diff --git a/lib/internal/Magento/Framework/Module/Output/Config.php b/lib/internal/Magento/Framework/Module/Output/Config.php
@@ -8,9 +8,9 @@
 namespace Magento\Framework\Module\Output;
 
 /**
- * Checks the module configuration
+ * Checks whether the module is enabled in the configuration.
  *
- * @deprecated because there are tools to change the module state in the admin panel and magento 2 CLI.
+ * @deprecated was removed from Magento
  */
 class Config implements \Magento\Framework\Module\Output\ConfigInterface
 {
diff --git a/lib/internal/Magento/Framework/Module/Output/ConfigInterface.php b/lib/internal/Magento/Framework/Module/Output/ConfigInterface.php
@@ -6,8 +6,9 @@
 namespace Magento\Framework\Module\Output;
 
 /**
- * Interface for classes to check module configuration
- * @deprecated because there are tools to change the module state in the admin panel and magento 2 CLI
+ * Checks whether the module is enabled in the configuration.
+ *
+ * @deprecated was removed from Magento
  */
 interface ConfigInterface
 {
diff --git a/lib/internal/Magento/Framework/Setup/FilePermissions.php b/lib/internal/Magento/Framework/Setup/FilePermissions.php
@@ -11,7 +11,7 @@
 use Magento\Framework\Filesystem;
 
 /**
- * Checks permissions to files and folders
+ * Checks permissions to files and folders.
  */
 class FilePermissions
 {

Original file line number	Diff line number	Diff line change
`@@ -63,14 +63,14 @@ public function getFormKey()`
`63`	`63`	`}`
`64`	`64`
`65`	`65`	`/**`
`66`		`- * Check whether or not the module output is enabled`
	`66`	`+ * Check whether or not the module output is enabled.`
`67`	`67`	`*`
`68`	`68`	`* Because many module blocks belong to Backend module,`
`69`		`- * the feature "Disable module output" doesn't cover Admin area`
	`69`	`+ * the feature "Disable module output" doesn't cover Admin area.`
`70`	`70`	`*`
`71`	`71`	`* @param string $moduleName Full module name`
`72`	`72`	`* @return boolean`
`73`		`- * @deprecated because there are tools to change the module state in the admin panel and magento 2 CLI.`
	`73`	`+ * @deprecated was removed from Magento`
`74`	`74`	`* @SuppressWarnings(PHPMD.UnusedFormalParameter)`
`75`	`75`	`*/`
`76`	`76`	`public function isOutputEnabled($moduleName = null)`
Original file line number	Diff line number	Diff line change
`@@ -6,11 +6,11 @@`
`6`	`6`	`namespace Magento\Config\Block\System\Config\Form\Fieldset\Modules;`
`7`	`7`
`8`	`8`	`/**`
`9`		`- * It displays a list of the inputs with names of the modules on tab Store->Configuration Advanced/Advanced`
`10`		`- * on the store settings page`
	`9`	`+ * Displays a list of the inputs with names of the modules on tab Store->Configuration Advanced/Advanced`
	`10`	`+ * on the store settings page.`
`11`	`11`	`*`
`12`	`12`	`* @method \Magento\Config\Block\System\Config\Form getForm()`
`13`		`- * @deprecated because there are tools to change the module state in the admin panel and magento 2 CLI.`
	`13`	`+ * @deprecated was removed from Magento`
`14`	`14`	`*/`
`15`	`15`	`class DisableOutput extends \Magento\Config\Block\System\Config\Form\Fieldset`
`16`	`16`	`{`
Original file line number	Diff line number	Diff line change
`@@ -80,7 +80,7 @@ public function __construct(`
`80`	`80`	`* );`
`81`	`81`	* ```
`82`	`82`	`*`
`83`		`- * @param string $fileName only basename`
	`83`	`+ * @param string $fileName the basename of file`
`84`	`84`	`* @return array`
`85`	`85`	`* @throws FileSystemException`
`86`	`86`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@`
`8`	`8`	`use Magento\Framework\Exception\FileSystemException;`
`9`	`9`
`10`	`10`	`/**`
`11`		`- * Interface of comments parser in the config file`
	`11`	`+ * Interface for parsing comments in the configuration file.`
`12`	`12`	`*/`
`13`	`13`	`interface CommentParserInterface`
`14`	`14`	`{`
Original file line number	Diff line number	Diff line change
`@@ -8,9 +8,9 @@`
`8`	`8`	`namespace Magento\Framework\Module\Output;`
`9`	`9`
`10`	`10`	`/**`
`11`		`- * Checks the module configuration`
	`11`	`+ * Checks whether the module is enabled in the configuration.`
`12`	`12`	`*`
`13`		`- * @deprecated because there are tools to change the module state in the admin panel and magento 2 CLI.`
	`13`	`+ * @deprecated was removed from Magento`
`14`	`14`	`*/`
`15`	`15`	`class Config implements \Magento\Framework\Module\Output\ConfigInterface`
`16`	`16`	`{`