MAGETWO-65444: Add @api annotation to Rule module

Alex Paliarush · Alex Paliarush · commit 176d35c85070 · 2017-04-12T11:52:57.000-05:00
diff --git a/app/code/Magento/Rule/Model/AbstractModel.php b/app/code/Magento/Rule/Model/AbstractModel.php
@@ -10,7 +10,9 @@
 
 /**
  * Abstract Rule entity data model
+ *
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
+ * @api
  */
 abstract class AbstractModel extends \Magento\Framework\Model\AbstractExtensibleModel
 {
diff --git a/app/code/Magento/Rule/Model/Action/AbstractAction.php b/app/code/Magento/Rule/Model/Action/AbstractAction.php
@@ -9,7 +9,9 @@
 use Magento\Framework\Data\Form\Element\AbstractElement;
 
 /**
- * Quote rule action abstract
+ * Abstract rule action
+ *
+ * @api
  */
 abstract class AbstractAction extends \Magento\Framework\DataObject implements ActionInterface
 {
diff --git a/app/code/Magento/Rule/Model/Action/ActionInterface.php b/app/code/Magento/Rule/Model/Action/ActionInterface.php
@@ -5,6 +5,9 @@
  */
 namespace Magento\Rule\Model\Action;
 
+/**
+ * @api
+ */
 interface ActionInterface
 {
 }
diff --git a/app/code/Magento/Rule/Model/Action/Collection.php b/app/code/Magento/Rule/Model/Action/Collection.php
@@ -5,6 +5,9 @@
  */
 namespace Magento\Rule\Model\Action;
 
+/**
+ * @api
+ */
 class Collection extends AbstractAction
 {
     /**
diff --git a/app/code/Magento/Rule/Model/ActionFactory.php b/app/code/Magento/Rule/Model/ActionFactory.php
@@ -3,8 +3,12 @@
  * Copyright © 2013-2017 Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+
 namespace Magento\Rule\Model;
 
+/**
+ * @api
+ */
 class ActionFactory
 {
     /**
diff --git a/app/code/Magento/Rule/Model/Condition/AbstractCondition.php b/app/code/Magento/Rule/Model/Condition/AbstractCondition.php
@@ -4,21 +4,20 @@
  * See COPYING.txt for license details.
  */
 
-/**
- * Abstract Rule condition data model
- *
- * @method string getOperator()
- * @method string getFormName()
- * @method setFormName()
- */
 namespace Magento\Rule\Model\Condition;
 
 use Magento\Framework\Data\Form;
 use Magento\Framework\Data\Form\Element\AbstractElement;
 
 /**
+ * Abstract Rule condition data model
+ *
+ * @method string getOperator()
+ * @method string getFormName()
+ * @method setFormName()
  * @SuppressWarnings(PHPMD.ExcessivePublicCount)
  * @SuppressWarnings(PHPMD.ExcessiveClassComplexity)
+ * @api
  */
 abstract class AbstractCondition extends \Magento\Framework\DataObject implements ConditionInterface
 {
diff --git a/app/code/Magento/Rule/Model/Condition/Combine.php b/app/code/Magento/Rule/Model/Condition/Combine.php
@@ -5,6 +5,9 @@
  */
 namespace Magento\Rule\Model\Condition;
 
+/**
+ * @api
+ */
 class Combine extends AbstractCondition
 {
     /**
diff --git a/app/code/Magento/Rule/Model/Condition/ConditionInterface.php b/app/code/Magento/Rule/Model/Condition/ConditionInterface.php
@@ -5,6 +5,9 @@
  */
 namespace Magento\Rule\Model\Condition;
 
+/**
+ * @api
+ */
 interface ConditionInterface
 {
     /**
diff --git a/app/code/Magento/Rule/Model/Condition/Context.php b/app/code/Magento/Rule/Model/Condition/Context.php
@@ -4,12 +4,13 @@
  * See COPYING.txt for license details.
  */
 
+namespace Magento\Rule\Model\Condition;
+
 /**
- * Abstract block context object. Will be used as rule condition constructor modification point after release.
+ * Abstract block context object. Is used as rule condition constructor modification point.
+ *
  * Important: Should not be modified by extension developers.
  */
-namespace Magento\Rule\Model\Condition;
-
 class Context implements \Magento\Framework\ObjectManager\ContextInterface
 {
     /**
diff --git a/app/code/Magento/Rule/Model/Condition/Product/AbstractProduct.php b/app/code/Magento/Rule/Model/Condition/Product/AbstractProduct.php
@@ -4,16 +4,14 @@
  * See COPYING.txt for license details.
  */
 
-/**
- * Abstract Rule product condition data model
- *
- * @author Magento Core Team <core@magentocommerce.com>
- */
 namespace Magento\Rule\Model\Condition\Product;
 
 /**
+ * Abstract Rule product condition data model
+ *
  * @SuppressWarnings(PHPMD.ExcessiveClassComplexity)
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
+ * @api
  */
 abstract class AbstractProduct extends \Magento\Rule\Model\Condition\AbstractCondition
 {
diff --git a/app/code/Magento/Rule/Model/Condition/Sql/Builder.php b/app/code/Magento/Rule/Model/Condition/Sql/Builder.php
@@ -12,8 +12,6 @@
 
 /**
  * Class SQL Builder
- *
- * @package Magento\Rule\Model\Condition\Sql
  */
 class Builder
 {
diff --git a/app/code/Magento/Rule/Model/Condition/Sql/Expression.php b/app/code/Magento/Rule/Model/Condition/Sql/Expression.php
@@ -4,13 +4,11 @@
  * See COPYING.txt for license details.
  */
 
+namespace Magento\Rule\Model\Condition\Sql;
+
 /**
  * Abstract Rule sql condition
- *
- * @author Magento Core Team <core@magentocommerce.com>
  */
-namespace Magento\Rule\Model\Condition\Sql;
-
 class Expression extends \Zend_Db_Expr
 {
     /**
diff --git a/app/code/Magento/Rule/Model/ResourceModel/AbstractResource.php b/app/code/Magento/Rule/Model/ResourceModel/AbstractResource.php
@@ -4,13 +4,13 @@
  * See COPYING.txt for license details.
  */
 
+namespace Magento\Rule\Model\ResourceModel;
+
 /**
  * Abstract Rule entity resource model
  *
- * @author Magento Core Team <core@magentocommerce.com>
+ * @api
  */
-namespace Magento\Rule\Model\ResourceModel;
-
 abstract class AbstractResource extends \Magento\Framework\Model\ResourceModel\Db\AbstractDb
 {
     /**
diff --git a/app/code/Magento/Rule/Model/ResourceModel/Rule/Collection/AbstractCollection.php b/app/code/Magento/Rule/Model/ResourceModel/Rule/Collection/AbstractCollection.php
@@ -4,13 +4,13 @@
  * See COPYING.txt for license details.
  */
 
+namespace Magento\Rule\Model\ResourceModel\Rule\Collection;
+
 /**
  * Abstract Rule entity resource collection model
  *
- * @author Magento Core Team <core@magentocommerce.com>
+ * @api
  */
-namespace Magento\Rule\Model\ResourceModel\Rule\Collection;
-
 abstract class AbstractCollection extends \Magento\Framework\Model\ResourceModel\Db\Collection\AbstractCollection
 {
     /**
diff --git a/app/code/Magento/Rule/view/adminhtml/web/rules.js b/app/code/Magento/Rule/view/adminhtml/web/rules.js
@@ -3,6 +3,10 @@
  * See COPYING.txt for license details.
  */
 
+/**
+ * @api
+ */
+
 define([
     "jquery",
     'Magento_Ui/js/modal/alert',

Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,9 @@`
`10`	`10`
`11`	`11`	`/**`
`12`	`12`	`* Abstract Rule entity data model`
	`13`	`+ *`
`13`	`14`	`* @SuppressWarnings(PHPMD.CouplingBetweenObjects)`
	`15`	`+ * @api`
`14`	`16`	`*/`
`15`	`17`	`abstract class AbstractModel extends \Magento\Framework\Model\AbstractExtensibleModel`
`16`	`18`	`{`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,9 @@`
`5`	`5`	`*/`
`6`	`6`	`namespace Magento\Rule\Model\Action;`
`7`	`7`
	`8`	`+/**`
	`9`	`+ * @api`
	`10`	`+ */`
`8`	`11`	`interface ActionInterface`
`9`	`12`	`{`
`10`	`13`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,9 @@`
`5`	`5`	`*/`
`6`	`6`	`namespace Magento\Rule\Model\Condition;`
`7`	`7`
	`8`	`+/**`
	`9`	`+ * @api`
	`10`	`+ */`
`8`	`11`	`class Combine extends AbstractCondition`
`9`	`12`	`{`
`10`	`13`	`/**`