MAGETWO-69846: Improve @api annotation coverage and comments

andimov · andimov · commit d70f54481d0e · 2017-06-15T17:03:04.000+03:00
diff --git a/app/code/Magento/Backend/Block/Widget/Grid/Column/Renderer/Button.php b/app/code/Magento/Backend/Block/Widget/Grid/Column/Renderer/Button.php
@@ -7,6 +7,7 @@
 
 /**
  * @api
+ * @SuppressWarnings(PHPMD.UnusedFormalParameter)
  */
 class Button extends \Magento\Backend\Block\Widget\Grid\Column\Renderer\AbstractRenderer
 {
diff --git a/app/code/Magento/Backend/Block/Widget/Grid/Massaction/Additional.php b/app/code/Magento/Backend/Block/Widget/Grid/Massaction/Additional.php
@@ -7,6 +7,7 @@
 
 /**
  * @api
+ * @SuppressWarnings(PHPMD.DepthOfInheritance)
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  * @deprecated in favour of UI component implementation
  */
diff --git a/app/code/Magento/Eav/Block/Adminhtml/Attribute/Grid/AbstractGrid.php b/app/code/Magento/Eav/Block/Adminhtml/Attribute/Grid/AbstractGrid.php
@@ -9,6 +9,7 @@
  * Product attributes grid
  *
  * @api
+ * @SuppressWarnings(PHPMD.DepthOfInheritance)
  * @deprecated
  */
 abstract class AbstractGrid extends \Magento\Backend\Block\Widget\Grid\Extended
diff --git a/app/code/Magento/Quote/Model/Quote/Address/Total/AbstractTotal.php b/app/code/Magento/Quote/Model/Quote/Address/Total/AbstractTotal.php
@@ -10,6 +10,7 @@
  *
  * @api
  * @SuppressWarnings(PHPMD.NumberOfChildren)
+ * @SuppressWarnings(PHPMD.UnusedFormalParameter)
  */
 abstract class AbstractTotal implements CollectorInterface, ReaderInterface
 {

Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,7 @@`
`7`	`7`
`8`	`8`	`/**`
`9`	`9`	`* @api`
	`10`	`+ * @SuppressWarnings(PHPMD.UnusedFormalParameter)`
`10`	`11`	`*/`
`11`	`12`	`class Button extends \Magento\Backend\Block\Widget\Grid\Column\Renderer\AbstractRenderer`
`12`	`13`	`{`
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@`
`9`	`9`	`* Product attributes grid`
`10`	`10`	`*`
`11`	`11`	`* @api`
	`12`	`+ * @SuppressWarnings(PHPMD.DepthOfInheritance)`
`12`	`13`	`* @deprecated`
`13`	`14`	`*/`
`14`	`15`	`abstract class AbstractGrid extends \Magento\Backend\Block\Widget\Grid\Extended`
Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,7 @@`
`10`	`10`	`*`
`11`	`11`	`* @api`
`12`	`12`	`* @SuppressWarnings(PHPMD.NumberOfChildren)`
	`13`	`+ * @SuppressWarnings(PHPMD.UnusedFormalParameter)`
`13`	`14`	`*/`
`14`	`15`	`abstract class AbstractTotal implements CollectorInterface, ReaderInterface`
`15`	`16`	`{`