MAGETWO-66143: Increase api coverage for catalog, catalogStaging and advancedCatalog modules

Andrey Konosov · Andrey Konosov · commit 44b5bbf4a013 · 2017-03-14T17:41:40.000+02:00
diff --git a/app/code/Magento/Catalog/Helper/Product/Composite.php b/app/code/Magento/Catalog/Helper/Product/Composite.php
@@ -17,6 +17,8 @@
 /**
  * Adminhtml catalog product composite helper
  *
+ * @api
+ *
  * @author     Magento Core Team <core@magentocommerce.com>
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
diff --git a/app/code/Magento/Catalog/Model/Indexer/AbstractFlatState.php b/app/code/Magento/Catalog/Model/Indexer/AbstractFlatState.php
@@ -7,6 +7,9 @@
 
 use Magento\Store\Model\ScopeInterface;
 
+/**
+ * @api
+ */
 abstract class AbstractFlatState
 {
     /**
diff --git a/app/code/Magento/Catalog/Model/Indexer/Category/Flat/SkipStaticColumnsProvider.php b/app/code/Magento/Catalog/Model/Indexer/Category/Flat/SkipStaticColumnsProvider.php
@@ -6,6 +6,11 @@
 
 namespace Magento\Catalog\Model\Indexer\Category\Flat;
 
+/**
+ * Static columns provider
+ *
+ * @api
+ */
 class SkipStaticColumnsProvider
 {
     /**
diff --git a/app/code/Magento/Catalog/Model/Indexer/Category/Flat/State.php b/app/code/Magento/Catalog/Model/Indexer/Category/Flat/State.php
@@ -5,6 +5,9 @@
  */
 namespace Magento\Catalog\Model\Indexer\Category\Flat;
 
+/**
+ * @api
+ */
 class State extends \Magento\Catalog\Model\Indexer\AbstractFlatState
 {
     /**
diff --git a/app/code/Magento/Catalog/Model/Indexer/Category/Product.php b/app/code/Magento/Catalog/Model/Indexer/Category/Product.php
@@ -7,6 +7,11 @@
 
 use Magento\Framework\Indexer\CacheContext;
 
+/**
+ * Category product indexer
+ *
+ * @api
+ */
 class Product implements \Magento\Framework\Indexer\ActionInterface, \Magento\Framework\Mview\ActionInterface
 {
     /**
diff --git a/app/code/Magento/Catalog/Model/Indexer/Category/Product/AbstractAction.php b/app/code/Magento/Catalog/Model/Indexer/Category/Product/AbstractAction.php
@@ -15,6 +15,9 @@
 
 /**
  * Class AbstractAction
+ *
+ * @api
+ *
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
 abstract class AbstractAction
diff --git a/app/code/Magento/Catalog/Model/Indexer/Product/Category.php b/app/code/Magento/Catalog/Model/Indexer/Product/Category.php
@@ -5,6 +5,9 @@
  */
 namespace Magento\Catalog\Model\Indexer\Product;
 
+/**
+ * @api
+ */
 class Category extends \Magento\Catalog\Model\Indexer\Category\Product
 {
     /**
diff --git a/app/code/Magento/Catalog/Model/Indexer/Product/Flat/Table/BuilderInterface.php b/app/code/Magento/Catalog/Model/Indexer/Product/Flat/Table/BuilderInterface.php
@@ -7,6 +7,8 @@
 
 /**
  * Interface BuilderInterface
+ *
+ * @api
  */
 interface BuilderInterface
 {
diff --git a/app/code/Magento/Catalog/Model/Product/Action.php b/app/code/Magento/Catalog/Model/Product/Action.php
@@ -11,6 +11,8 @@
 /**
  * Catalog Product Mass Action processing model
  *
+ * @api
+ *
  * @author      Magento Core Team <core@magentocommerce.com>
  */
 class Action extends \Magento\Framework\Model\AbstractModel
diff --git a/app/code/Magento/Catalog/Model/Product/CatalogPriceInterface.php b/app/code/Magento/Catalog/Model/Product/CatalogPriceInterface.php
@@ -4,11 +4,13 @@
  * See COPYING.txt for license details.
  */
 
+namespace Magento\Catalog\Model\Product;
+
 /**
  * Product price interface for external catalogs
+ *
+ * @api
  */
-namespace Magento\Catalog\Model\Product;
-
 interface CatalogPriceInterface
 {
     /**
diff --git a/app/code/Magento/Catalog/Model/Product/Compare/Item.php b/app/code/Magento/Catalog/Model/Product/Compare/Item.php
@@ -10,6 +10,8 @@
 /**
  * Catalog Compare Item Model
  *
+ * @api
+ *
  * @method \Magento\Catalog\Model\ResourceModel\Product\Compare\Item getResource()
  * @method \Magento\Catalog\Model\Product\Compare\Item setVisitorId(int $value)
  * @method \Magento\Catalog\Model\Product\Compare\Item setCustomerId(int $value)
diff --git a/app/code/Magento/Catalog/Model/Product/Link/Converter.php b/app/code/Magento/Catalog/Model/Product/Link/Converter.php
@@ -7,6 +7,8 @@
 
 /**
  * Class Converter
+ *
+ * @api
  */
 class Converter
 {
diff --git a/app/code/Magento/Catalog/Model/Product/Link/Resolver.php b/app/code/Magento/Catalog/Model/Product/Link/Resolver.php
@@ -5,6 +5,9 @@
  */
 namespace Magento\Catalog\Model\Product\Link;
 
+/**
+ * @api
+ */
 class Resolver
 {
     /**
diff --git a/app/code/Magento/Catalog/Model/Product/Price/Validation/Result.php b/app/code/Magento/Catalog/Model/Product/Price/Validation/Result.php
@@ -8,6 +8,8 @@
 
 /**
  * Validation Result is used to aggregate errors that occurred during price update.
+ *
+ * @api
  */
 class Result
 {
diff --git a/app/code/Magento/Catalog/Model/ResourceModel/Product/Compare/Item/Collection.php b/app/code/Magento/Catalog/Model/ResourceModel/Product/Compare/Item/Collection.php
@@ -8,6 +8,8 @@
 /**
  * Catalog Product Compare Items Resource Collection
  *
+ * @api
+ *
  * @author      Magento Core Team <core@magentocommerce.com>
  * @SuppressWarnings(PHPMD.LongVariable)
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
diff --git a/app/code/Magento/Catalog/Ui/Component/Category/Form/Element/Wysiwyg.php b/app/code/Magento/Catalog/Ui/Component/Category/Form/Element/Wysiwyg.php
@@ -16,6 +16,8 @@
 
 /**
  * Catalog Wysiwyg
+ *
+ * @api
  */
 class Wysiwyg extends \Magento\Ui\Component\Form\Element\Wysiwyg
 {
diff --git a/app/code/Magento/Catalog/Ui/Component/Listing/Filters.php b/app/code/Magento/Catalog/Ui/Component/Listing/Filters.php
@@ -11,8 +11,6 @@
 use Magento\Framework\View\Element\UiComponentInterface;
 
 /**
- *
- *
  * @api
  */
 class Filters implements ObserverInterface
diff --git a/app/code/Magento/Catalog/Ui/DataProvider/Product/Form/Modifier/AdvancedPricing.php b/app/code/Magento/Catalog/Ui/DataProvider/Product/Form/Modifier/AdvancedPricing.php
@@ -27,6 +27,8 @@
 
 /**
  * Class AdvancedPricing
+ * 
+ * @api
  *
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
diff --git a/app/code/Magento/Catalog/Ui/DataProvider/Product/Form/Modifier/AttributeSet.php b/app/code/Magento/Catalog/Ui/DataProvider/Product/Form/Modifier/AttributeSet.php
@@ -14,6 +14,8 @@
 
 /**
  * Add "Attribute Set" to first fieldset
+ *
+ * @api
  */
 class AttributeSet extends AbstractModifier
 {
diff --git a/app/code/Magento/Catalog/Ui/DataProvider/Product/Form/Modifier/Attributes.php b/app/code/Magento/Catalog/Ui/DataProvider/Product/Form/Modifier/Attributes.php
@@ -14,6 +14,8 @@
 
 /**
  * Class Attributes
+ *
+ * @api
  */
 class Attributes extends AbstractModifier
 {
diff --git a/app/code/Magento/Catalog/Ui/DataProvider/Product/Form/Modifier/Categories.php b/app/code/Magento/Catalog/Ui/DataProvider/Product/Form/Modifier/Categories.php
@@ -17,6 +17,9 @@
 
 /**
  * Data provider for categories field of product page
+ *
+ * @api
+ *
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
 class Categories extends AbstractModifier
diff --git a/app/code/Magento/Catalog/Ui/DataProvider/Product/Form/Modifier/Eav.php b/app/code/Magento/Catalog/Ui/DataProvider/Product/Form/Modifier/Eav.php
@@ -35,6 +35,8 @@
 /**
  * Class Eav
  *
+ * @api
+ *
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  * @SuppressWarnings(PHPMD.TooManyFields)
  */
diff --git a/app/code/Magento/Catalog/Ui/DataProvider/Product/Form/Modifier/General.php b/app/code/Magento/Catalog/Ui/DataProvider/Product/Form/Modifier/General.php
@@ -12,6 +12,8 @@
 
 /**
  * Data provider for main panel of product page
+ *
+ * @api
  */
 class General extends AbstractModifier
 {
diff --git a/app/code/Magento/Catalog/Ui/DataProvider/Product/Form/Modifier/Images.php b/app/code/Magento/Catalog/Ui/DataProvider/Product/Form/Modifier/Images.php
@@ -9,6 +9,8 @@
 
 /**
  * Class Images customizes Images panel
+ *
+ * @api
  */
 class Images extends AbstractModifier
 {
diff --git a/app/code/Magento/Catalog/Ui/DataProvider/Product/Form/Modifier/Related.php b/app/code/Magento/Catalog/Ui/DataProvider/Product/Form/Modifier/Related.php
@@ -26,6 +26,9 @@
 
 /**
  * Class Related
+ *
+ * @api
+ *
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
 class Related extends AbstractModifier
diff --git a/app/code/Magento/Catalog/Ui/DataProvider/Product/Form/Modifier/ScheduleDesignUpdate.php b/app/code/Magento/Catalog/Ui/DataProvider/Product/Form/Modifier/ScheduleDesignUpdate.php
@@ -9,6 +9,8 @@
 
 /**
  * Class ScheduleDesignUpdateMetaProvider customizes Schedule Design Update panel
+ *
+ * @api
  */
 class ScheduleDesignUpdate extends AbstractModifier
 {
diff --git a/app/code/Magento/Catalog/Ui/DataProvider/Product/Form/Modifier/System.php b/app/code/Magento/Catalog/Ui/DataProvider/Product/Form/Modifier/System.php
@@ -10,6 +10,8 @@
 
 /**
  * Class SystemDataProvider
+ *
+ * @api
  */
 class System extends AbstractModifier
 {
diff --git a/app/code/Magento/Catalog/Ui/DataProvider/Product/Form/Modifier/TierPrice.php b/app/code/Magento/Catalog/Ui/DataProvider/Product/Form/Modifier/TierPrice.php
@@ -16,6 +16,8 @@
 
 /**
  * Tier prices modifier adds price type option to tier prices.
+ *
+ * @api
  */
 class TierPrice extends AbstractModifier
 {
diff --git a/app/code/Magento/Catalog/Ui/DataProvider/Product/Form/Modifier/Websites.php b/app/code/Magento/Catalog/Ui/DataProvider/Product/Form/Modifier/Websites.php
@@ -15,6 +15,9 @@
 
 /**
  * Class Websites customizes websites panel
+ *
+ * @api
+ *
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
 class Websites extends AbstractModifier
diff --git a/app/code/Magento/Catalog/Ui/DataProvider/Product/Form/ProductDataProvider.php b/app/code/Magento/Catalog/Ui/DataProvider/Product/Form/ProductDataProvider.php
@@ -12,6 +12,8 @@
 
 /**
  * DataProvider for product edit form
+ *
+ * @api
  */
 class ProductDataProvider extends AbstractDataProvider
 {
diff --git a/app/code/Magento/Catalog/Ui/DataProvider/Product/Related/CrossSellDataProvider.php b/app/code/Magento/Catalog/Ui/DataProvider/Product/Related/CrossSellDataProvider.php
@@ -7,6 +7,8 @@
 
 /**
  * Class CrossSellDataProvider
+ *
+ * @api
  */
 class CrossSellDataProvider extends AbstractDataProvider
 {
diff --git a/app/code/Magento/Catalog/Ui/DataProvider/Product/Related/RelatedDataProvider.php b/app/code/Magento/Catalog/Ui/DataProvider/Product/Related/RelatedDataProvider.php
@@ -7,6 +7,8 @@
 
 /**
  * Class RelatedDataProvider
+ *
+ * @api
  */
 class RelatedDataProvider extends AbstractDataProvider
 {
diff --git a/app/code/Magento/Catalog/Ui/DataProvider/Product/Related/UpSellDataProvider.php b/app/code/Magento/Catalog/Ui/DataProvider/Product/Related/UpSellDataProvider.php
@@ -7,6 +7,8 @@
 
 /**
  * Class UpSellDataProvider
+ *
+ * @api
  */
 class UpSellDataProvider extends AbstractDataProvider
 {

Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,8 @@`
`17`	`17`	`/**`
`18`	`18`	`* Adminhtml catalog product composite helper`
`19`	`19`	`*`
	`20`	`+ * @api`
	`21`	`+ *`
`20`	`22`	`* @author Magento Core Team <core@magentocommerce.com>`
`21`	`23`	`* @SuppressWarnings(PHPMD.CouplingBetweenObjects)`
`22`	`24`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,9 @@`
`7`	`7`
`8`	`8`	`use Magento\Store\Model\ScopeInterface;`
`9`	`9`
	`10`	`+/**`
	`11`	`+ * @api`
	`12`	`+ */`
`10`	`13`	`abstract class AbstractFlatState`
`11`	`14`	`{`
`12`	`15`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,9 @@`
`5`	`5`	`*/`
`6`	`6`	`namespace Magento\Catalog\Model\Indexer\Category\Flat;`
`7`	`7`
	`8`	`+/**`
	`9`	`+ * @api`
	`10`	`+ */`
`8`	`11`	`class State extends \Magento\Catalog\Model\Indexer\AbstractFlatState`
`9`	`12`	`{`
`10`	`13`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,8 @@`
`7`	`7`
`8`	`8`	`/**`
`9`	`9`	`* Interface BuilderInterface`
	`10`	`+ *`
	`11`	`+ * @api`
`10`	`12`	`*/`
`11`	`13`	`interface BuilderInterface`
`12`	`14`	`{`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,8 @@`
`11`	`11`	`/**`
`12`	`12`	`* Catalog Product Mass Action processing model`
`13`	`13`	`*`
	`14`	`+ * @api`
	`15`	`+ *`
`14`	`16`	`* @author Magento Core Team <core@magentocommerce.com>`
`15`	`17`	`*/`
`16`	`18`	`class Action extends \Magento\Framework\Model\AbstractModel`