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

Andrey Konosov · Andrey Konosov · commit 4cbccdf0b74f · 2017-03-14T18:57:11.000+02:00
diff --git a/app/code/Magento/Catalog/Helper/Product/Compare.php b/app/code/Magento/Catalog/Helper/Product/Compare.php
@@ -11,6 +11,8 @@
 /**
  * Catalog Product Compare Helper
  *
+ * @api
+ *
  * @SuppressWarnings(PHPMD.LongVariable)
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
diff --git a/app/code/Magento/Catalog/Helper/Product/ConfigurationPool.php b/app/code/Magento/Catalog/Helper/Product/ConfigurationPool.php
@@ -5,6 +5,9 @@
  */
 namespace Magento\Catalog\Helper\Product;
 
+/**
+ * @api
+ */
 class ConfigurationPool
 {
     /**
diff --git a/app/code/Magento/Catalog/Helper/Product/ProductList.php b/app/code/Magento/Catalog/Helper/Product/ProductList.php
@@ -10,6 +10,8 @@
 
 /**
  * Class ProductList
+ *
+ * @api
  */
 class ProductList
 {
diff --git a/app/code/Magento/Catalog/Model/Attribute/Backend/Customlayoutupdate.php b/app/code/Magento/Catalog/Model/Attribute/Backend/Customlayoutupdate.php
@@ -9,7 +9,9 @@
 use Magento\Eav\Model\Entity\Attribute\Exception;
 
 /**
- * Product url key attribute backend
+ * Layout update attribute backend
+ *
+ * @api
  *
  * @SuppressWarnings(PHPMD.LongVariable)
  */
diff --git a/app/code/Magento/Catalog/Model/Attribute/Backend/Startdate.php b/app/code/Magento/Catalog/Model/Attribute/Backend/Startdate.php
@@ -9,6 +9,8 @@
  *
  * Speical Start Date attribute backend
  *
+ * @api
+ *
  * @author      Magento Core Team <core@magentocommerce.com>
  */
 class Startdate extends \Magento\Eav\Model\Entity\Attribute\Backend\Datetime
diff --git a/app/code/Magento/Catalog/Model/Category/Attribute/Backend/Image.php b/app/code/Magento/Catalog/Model/Category/Attribute/Backend/Image.php
@@ -7,6 +7,8 @@
 /**
  * Catalog category image attribute backend model
  *
+ * @api
+ *
  * @author      Magento Core Team <core@magentocommerce.com>
  */
 namespace Magento\Catalog\Model\Category\Attribute\Backend;
diff --git a/app/code/Magento/Catalog/Model/Category/Attribute/Backend/Sortby.php b/app/code/Magento/Catalog/Model/Category/Attribute/Backend/Sortby.php
@@ -8,6 +8,8 @@
 /**
  * Catalog Category Attribute Default and Available Sort By Backend Model
  *
+ * @api
+ *
  * @author     Magento Core Team <core@magentocommerce.com>
  */
 class Sortby extends \Magento\Eav\Model\Entity\Attribute\Backend\AbstractBackend
diff --git a/app/code/Magento/Catalog/Model/Layer/AvailabilityFlagInterface.php b/app/code/Magento/Catalog/Model/Layer/AvailabilityFlagInterface.php
@@ -6,6 +6,9 @@
  */
 namespace Magento\Catalog\Model\Layer;
 
+/**
+ * @api
+ */
 interface AvailabilityFlagInterface
 {
     /**
diff --git a/app/code/Magento/Catalog/Model/Layer/Filter/Dynamic/AlgorithmInterface.php b/app/code/Magento/Catalog/Model/Layer/Filter/Dynamic/AlgorithmInterface.php
@@ -5,6 +5,9 @@
  */
 namespace Magento\Catalog\Model\Layer\Filter\Dynamic;
 
+/**
+ * @api
+ */
 interface AlgorithmInterface
 {
     /**
diff --git a/app/code/Magento/Catalog/Model/Layer/Filter/FilterInterface.php b/app/code/Magento/Catalog/Model/Layer/Filter/FilterInterface.php
@@ -7,6 +7,8 @@
 
 /**
  * Layer filter interface
+ *
+ * @api
  */
 interface FilterInterface
 {
diff --git a/app/code/Magento/Catalog/Model/Product/Compare/ListCompare.php b/app/code/Magento/Catalog/Model/Product/Compare/ListCompare.php
@@ -10,6 +10,8 @@
 /**
  * Product Compare List Model
  *
+ * @api
+ *
  * @SuppressWarnings(PHPMD.LongVariable)
  */
 class ListCompare extends \Magento\Framework\DataObject
diff --git a/app/code/Magento/Catalog/Model/Product/Option/Type/DefaultType.php b/app/code/Magento/Catalog/Model/Product/Option/Type/DefaultType.php
@@ -13,6 +13,8 @@
 /**
  * Catalog product option default type
  *
+ * @api
+ *
  * @author     Magento Core Team <core@magentocommerce.com>
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
diff --git a/app/code/Magento/Catalog/Model/Product/ProductList/Toolbar.php b/app/code/Magento/Catalog/Model/Product/ProductList/Toolbar.php
@@ -7,6 +7,8 @@
 
 /**
  * Class Toolbar
+ *
+ * @api
  */
 class Toolbar
 {
diff --git a/app/code/Magento/Catalog/Model/ResourceModel/AbstractResource.php b/app/code/Magento/Catalog/Model/ResourceModel/AbstractResource.php
@@ -12,6 +12,9 @@
 
 /**
  * Catalog entity abstract model
+ *
+ * @api
+ *
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
 abstract class AbstractResource extends \Magento\Eav\Model\Entity\AbstractEntity
diff --git a/app/code/Magento/Catalog/Model/Session.php b/app/code/Magento/Catalog/Model/Session.php
@@ -7,6 +7,8 @@
 
 /**
  * Catalog session model
+ *
+ * @api
  */
 class Session extends \Magento\Framework\Session\SessionManager
 {
diff --git a/app/code/Magento/Catalog/Pricing/Render.php b/app/code/Magento/Catalog/Pricing/Render.php
@@ -15,6 +15,8 @@
 /**
  * Catalog Price Render
  *
+ * @api
+ *
  * @method string getPriceRender()
  * @method string getPriceTypeCode()
  */
diff --git a/app/code/Magento/Catalog/Ui/Component/Listing/Attribute/Repository.php b/app/code/Magento/Catalog/Ui/Component/Listing/Attribute/Repository.php
@@ -5,6 +5,9 @@
  */
 namespace Magento\Catalog\Ui\Component\Listing\Attribute;
 
+/**
+ * @api
+ */
 class Repository extends AbstractRepository
 {
     /**
diff --git a/app/code/Magento/Catalog/Ui/DataProvider/CatalogEavValidationRules.php b/app/code/Magento/Catalog/Ui/DataProvider/CatalogEavValidationRules.php
@@ -9,6 +9,8 @@
 
 /**
  * Class build validation rules for catalog EAV attributes
+ *
+ * @api
  */
 class CatalogEavValidationRules
 {
diff --git a/app/code/Magento/Catalog/Ui/DataProvider/Product/AddStoreFieldToCollection.php b/app/code/Magento/Catalog/Ui/DataProvider/Product/AddStoreFieldToCollection.php
@@ -9,6 +9,9 @@
 use Magento\Store\Model\StoreManagerInterface;
 use Magento\Ui\DataProvider\AddFilterToCollectionInterface;
 
+/**
+ * @api
+ */
 class AddStoreFieldToCollection implements AddFilterToCollectionInterface
 {
     /**
diff --git a/app/code/Magento/Catalog/Ui/DataProvider/Product/AddWebsitesFieldToCollection.php b/app/code/Magento/Catalog/Ui/DataProvider/Product/AddWebsitesFieldToCollection.php
@@ -10,6 +10,8 @@
 
 /**
  * Class AddWebsitesFieldToCollection
+ *
+ * @api
  */
 class AddWebsitesFieldToCollection implements AddFieldToCollectionInterface
 {
diff --git a/app/code/Magento/Catalog/Ui/DataProvider/Product/ProductCustomOptionsDataProvider.php b/app/code/Magento/Catalog/Ui/DataProvider/Product/ProductCustomOptionsDataProvider.php
@@ -15,6 +15,8 @@
 
 /**
  * DataProvider for grid on Import Custom Options modal panel
+ *
+ * @api
  */
 class ProductCustomOptionsDataProvider extends ProductDataProvider
 {
diff --git a/app/code/Magento/Catalog/Ui/DataProvider/Product/Related/AbstractDataProvider.php b/app/code/Magento/Catalog/Ui/DataProvider/Product/Related/AbstractDataProvider.php
@@ -18,6 +18,8 @@
 
 /**
  * Class AbstractDataProvider
+ *
+ * @api
  */
 abstract class AbstractDataProvider extends ProductDataProvider
 {

Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,8 @@`
`11`	`11`	`/**`
`12`	`12`	`* Catalog Product Compare Helper`
`13`	`13`	`*`
	`14`	`+ * @api`
	`15`	`+ *`
`14`	`16`	`* @SuppressWarnings(PHPMD.LongVariable)`
`15`	`17`	`* @SuppressWarnings(PHPMD.CouplingBetweenObjects)`
`16`	`18`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,9 @@`
`5`	`5`	`*/`
`6`	`6`	`namespace Magento\Catalog\Helper\Product;`
`7`	`7`
	`8`	`+/**`
	`9`	`+ * @api`
	`10`	`+ */`
`8`	`11`	`class ConfigurationPool`
`9`	`12`	`{`
`10`	`13`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,8 @@`
`10`	`10`
`11`	`11`	`/**`
`12`	`12`	`* Class ProductList`
	`13`	`+ *`
	`14`	`+ * @api`
`13`	`15`	`*/`
`14`	`16`	`class ProductList`
`15`	`17`	`{`
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,8 @@`
`9`	`9`	`*`
`10`	`10`	`* Speical Start Date attribute backend`
`11`	`11`	`*`
	`12`	`+ * @api`
	`13`	`+ *`
`12`	`14`	`* @author Magento Core Team <core@magentocommerce.com>`
`13`	`15`	`*/`
`14`	`16`	`class Startdate extends \Magento\Eav\Model\Entity\Attribute\Backend\Datetime`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,8 @@`
`7`	`7`	`/**`
`8`	`8`	`* Catalog category image attribute backend model`
`9`	`9`	`*`
	`10`	`+ * @api`
	`11`	`+ *`
`10`	`12`	`* @author Magento Core Team <core@magentocommerce.com>`
`11`	`13`	`*/`
`12`	`14`	`namespace Magento\Catalog\Model\Category\Attribute\Backend;`
Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,8 @@`
`8`	`8`	`/**`
`9`	`9`	`* Catalog Category Attribute Default and Available Sort By Backend Model`
`10`	`10`	`*`
	`11`	`+ * @api`
	`12`	`+ *`
`11`	`13`	`* @author Magento Core Team <core@magentocommerce.com>`
`12`	`14`	`*/`
`13`	`15`	`class Sortby extends \Magento\Eav\Model\Entity\Attribute\Backend\AbstractBackend`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,9 @@`
`6`	`6`	`*/`
`7`	`7`	`namespace Magento\Catalog\Model\Layer;`
`8`	`8`
	`9`	`+/**`
	`10`	`+ * @api`
	`11`	`+ */`
`9`	`12`	`interface AvailabilityFlagInterface`
`10`	`13`	`{`
`11`	`14`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,9 @@`
`5`	`5`	`*/`
`6`	`6`	`namespace Magento\Catalog\Model\Layer\Filter\Dynamic;`
`7`	`7`
	`8`	`+/**`
	`9`	`+ * @api`
	`10`	`+ */`
`8`	`11`	`interface AlgorithmInterface`
`9`	`12`	`{`
`10`	`13`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,8 @@`
`7`	`7`
`8`	`8`	`/**`
`9`	`9`	`* Layer filter interface`
	`10`	`+ *`
	`11`	`+ * @api`
`10`	`12`	`*/`
`11`	`13`	`interface FilterInterface`
`12`	`14`	`{`