MAGETWO-66599: Add @api Annotation for ConfigurableProduct Module

Yaroslav Onischenko · Yaroslav Onischenko · commit 4a55a7167242 · 2017-04-14T16:48:03.000+03:00
diff --git a/app/code/Magento/ConfigurableProduct/Block/Adminhtml/Order/Create/Sidebar.php b/app/code/Magento/ConfigurableProduct/Block/Adminhtml/Order/Create/Sidebar.php
@@ -7,6 +7,9 @@
 
 use Magento\ConfigurableProduct\Model\Product\Type\Configurable;
 
+/**
+ * @api
+ */
 class Sidebar
 {
     /**
diff --git a/app/code/Magento/ConfigurableProduct/Block/Adminhtml/Product/Attribute/NewAttribute/Product/Created.php b/app/code/Magento/ConfigurableProduct/Block/Adminhtml/Product/Attribute/NewAttribute/Product/Created.php
@@ -11,6 +11,9 @@
  */
 namespace Magento\ConfigurableProduct\Block\Adminhtml\Product\Attribute\NewAttribute\Product;
 
+/**
+ * @api
+ */
 class Created extends \Magento\Backend\Block\Widget
 {
     /**
diff --git a/app/code/Magento/ConfigurableProduct/Block/Adminhtml/Product/Steps/AttributeValues.php b/app/code/Magento/ConfigurableProduct/Block/Adminhtml/Product/Steps/AttributeValues.php
@@ -7,6 +7,9 @@
  */
 namespace Magento\ConfigurableProduct\Block\Adminhtml\Product\Steps;
 
+/**
+ * @api
+ */
 class AttributeValues extends \Magento\Ui\Block\Component\StepsWizard\StepAbstract
 {
     /**
diff --git a/app/code/Magento/ConfigurableProduct/Block/Adminhtml/Product/Steps/Bulk.php b/app/code/Magento/ConfigurableProduct/Block/Adminhtml/Product/Steps/Bulk.php
@@ -15,6 +15,9 @@
 use Magento\Eav\Model\Entity\Attribute;
 use Magento\Framework\View\Element\Template\Context;
 
+/**
+ * @api
+ */
 class Bulk extends \Magento\Ui\Block\Component\StepsWizard\StepAbstract
 {
     /** @var Image */
diff --git a/app/code/Magento/ConfigurableProduct/Block/Adminhtml/Product/Steps/SelectAttributes.php b/app/code/Magento/ConfigurableProduct/Block/Adminhtml/Product/Steps/SelectAttributes.php
@@ -7,6 +7,9 @@
  */
 namespace Magento\ConfigurableProduct\Block\Adminhtml\Product\Steps;
 
+/**
+ * @api
+ */
 class SelectAttributes extends \Magento\Ui\Block\Component\StepsWizard\StepAbstract
 {
     /**
diff --git a/app/code/Magento/ConfigurableProduct/Block/Adminhtml/Product/Steps/Summary.php b/app/code/Magento/ConfigurableProduct/Block/Adminhtml/Product/Steps/Summary.php
@@ -7,6 +7,9 @@
  */
 namespace Magento\ConfigurableProduct\Block\Adminhtml\Product\Steps;
 
+/**
+ * @api
+ */
 class Summary extends \Magento\Ui\Block\Component\StepsWizard\StepAbstract
 {
     /**
diff --git a/app/code/Magento/ConfigurableProduct/Block/Cart/Item/Renderer/Configurable.php b/app/code/Magento/ConfigurableProduct/Block/Cart/Item/Renderer/Configurable.php
@@ -11,6 +11,7 @@
 
 /**
  * Shopping cart item render block for configurable products.
+ * @api
  */
 class Configurable extends Renderer implements IdentityInterface
 {
diff --git a/app/code/Magento/ConfigurableProduct/Block/Product/Configurable/AssociatedSelector/Renderer/Id.php b/app/code/Magento/ConfigurableProduct/Block/Product/Configurable/AssociatedSelector/Renderer/Id.php
@@ -7,6 +7,9 @@
  */
 namespace Magento\ConfigurableProduct\Block\Product\Configurable\AssociatedSelector\Renderer;
 
+/**
+ * @api
+ */
 class Id extends \Magento\Backend\Block\Widget\Grid\Column\Renderer\AbstractRenderer
 {
     /**
diff --git a/app/code/Magento/ConfigurableProduct/Block/Product/Configurable/AttributeSelector.php b/app/code/Magento/ConfigurableProduct/Block/Product/Configurable/AttributeSelector.php
@@ -9,6 +9,7 @@
 
 /**
  * @SuppressWarnings(PHPMD.LongVariable)
+ * @api
  */
 class AttributeSelector extends \Magento\Backend\Block\Template
 {
diff --git a/app/code/Magento/ConfigurableProduct/Block/Product/View/Type/Configurable.php b/app/code/Magento/ConfigurableProduct/Block/Product/View/Type/Configurable.php
@@ -13,6 +13,7 @@
 
 /**
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
+ * @api
  */
 class Configurable extends \Magento\Catalog\Block\Product\View\AbstractView
 {
diff --git a/app/code/Magento/ConfigurableProduct/Block/Stockqty/Type/Configurable.php b/app/code/Magento/ConfigurableProduct/Block/Stockqty/Type/Configurable.php
@@ -9,6 +9,7 @@
 
 /**
  * Product stock qty block for configurable product type
+ * @api
  */
 class Configurable extends \Magento\CatalogInventory\Block\Stockqty\Composite
 {
diff --git a/app/code/Magento/ConfigurableProduct/Helper/Data.php b/app/code/Magento/ConfigurableProduct/Helper/Data.php
@@ -11,7 +11,7 @@
 /**
  * Class Data
  * Helper class for getting options
- *
+ * @api
  */
 class Data
 {
diff --git a/app/code/Magento/ConfigurableProduct/Helper/Product/Options/Factory.php b/app/code/Magento/ConfigurableProduct/Helper/Product/Options/Factory.php
@@ -14,6 +14,7 @@
 
 /**
  * Class Factory
+ * @api
  */
 class Factory
 {
diff --git a/app/code/Magento/ConfigurableProduct/Model/AttributeOptionProviderInterface.php b/app/code/Magento/ConfigurableProduct/Model/AttributeOptionProviderInterface.php
@@ -7,6 +7,7 @@
 
 /**
  * Interface to retrieve options for attribute
+ * @api
  */
 interface AttributeOptionProviderInterface
 {
diff --git a/app/code/Magento/ConfigurableProduct/Model/AttributesListInterface.php b/app/code/Magento/ConfigurableProduct/Model/AttributesListInterface.php
@@ -5,6 +5,9 @@
  */
 namespace Magento\ConfigurableProduct\Model;
 
+/**
+ * @api
+ */
 interface AttributesListInterface
 {
     /**
diff --git a/app/code/Magento/ConfigurableProduct/Model/ConfigurableAttributeData.php b/app/code/Magento/ConfigurableProduct/Model/ConfigurableAttributeData.php
@@ -11,6 +11,7 @@
 
 /**
  * Class ConfigurableAttributeData
+ * @api
  */
 class ConfigurableAttributeData
 {
diff --git a/app/code/Magento/ConfigurableProduct/Model/Product/Type/Configurable.php b/app/code/Magento/ConfigurableProduct/Model/Product/Type/Configurable.php
@@ -23,6 +23,7 @@
  * @SuppressWarnings(PHPMD.TooManyFields)
  * @SuppressWarnings(PHPMD.ExcessiveClassComplexity)
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
+ * @api
  */
 class Configurable extends \Magento\Catalog\Model\Product\Type\AbstractType
 {
diff --git a/app/code/Magento/ConfigurableProduct/Model/Product/Type/VariationMatrix.php b/app/code/Magento/ConfigurableProduct/Model/Product/Type/VariationMatrix.php
@@ -5,6 +5,9 @@
  */
 namespace Magento\ConfigurableProduct\Model\Product\Type;
 
+/**
+ * @api
+ */
 class VariationMatrix
 {
     /**
diff --git a/app/code/Magento/ConfigurableProduct/Model/Product/VariationHandler.php b/app/code/Magento/ConfigurableProduct/Model/Product/VariationHandler.php
@@ -11,6 +11,7 @@
 /**
  * Variation Handler
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
+ * @api
  */
 class VariationHandler
 {
diff --git a/app/code/Magento/ConfigurableProduct/Pricing/Price/PriceResolverInterface.php b/app/code/Magento/ConfigurableProduct/Pricing/Price/PriceResolverInterface.php
@@ -6,6 +6,9 @@
 
 namespace Magento\ConfigurableProduct\Pricing\Price;
 
+/**
+ * @api
+ */
 interface PriceResolverInterface
 {
     /**
diff --git a/app/code/Magento/ConfigurableProduct/Ui/Component/Listing/AssociatedProduct/Attribute/Repository.php b/app/code/Magento/ConfigurableProduct/Ui/Component/Listing/AssociatedProduct/Attribute/Repository.php
@@ -5,6 +5,9 @@
  */
 namespace Magento\ConfigurableProduct\Ui\Component\Listing\AssociatedProduct\Attribute;
 
+/**
+ * @api
+ */
 class Repository extends \Magento\Catalog\Ui\Component\Listing\Attribute\AbstractRepository
 {
     /** @var \Magento\Framework\App\RequestInterface */
diff --git a/app/code/Magento/ConfigurableProduct/Ui/Component/Listing/AssociatedProduct/Filters.php b/app/code/Magento/ConfigurableProduct/Ui/Component/Listing/AssociatedProduct/Filters.php
@@ -10,6 +10,9 @@
 use Magento\Framework\View\Element\UiComponent\ObserverInterface;
 use Magento\Framework\View\Element\UiComponentInterface;
 
+/**
+ * @api
+ */
 class Filters implements ObserverInterface
 {
     /**
diff --git a/app/code/Magento/ConfigurableProduct/view/frontend/web/js/configurable.js b/app/code/Magento/ConfigurableProduct/view/frontend/web/js/configurable.js
@@ -2,7 +2,9 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
-
+/**
+ * @api
+ */
 define([
     'jquery',
     'underscore',

Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,9 @@`
`7`	`7`
`8`	`8`	`use Magento\ConfigurableProduct\Model\Product\Type\Configurable;`
`9`	`9`
	`10`	`+/**`
	`11`	`+ * @api`
	`12`	`+ */`
`10`	`13`	`class Sidebar`
`11`	`14`	`{`
`12`	`15`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,9 @@`
`11`	`11`	`*/`
`12`	`12`	`namespace Magento\ConfigurableProduct\Block\Adminhtml\Product\Attribute\NewAttribute\Product;`
`13`	`13`
	`14`	`+/**`
	`15`	`+ * @api`
	`16`	`+ */`
`14`	`17`	`class Created extends \Magento\Backend\Block\Widget`
`15`	`18`	`{`
`16`	`19`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,9 @@`
`15`	`15`	`use Magento\Eav\Model\Entity\Attribute;`
`16`	`16`	`use Magento\Framework\View\Element\Template\Context;`
`17`	`17`
	`18`	`+/**`
	`19`	`+ * @api`
	`20`	`+ */`
`18`	`21`	`class Bulk extends \Magento\Ui\Block\Component\StepsWizard\StepAbstract`
`19`	`22`	`{`
`20`	`23`	`/** @var Image */`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,7 @@`
`11`	`11`
`12`	`12`	`/**`
`13`	`13`	`* Shopping cart item render block for configurable products.`
	`14`	`+ * @api`
`14`	`15`	`*/`
`15`	`16`	`class Configurable extends Renderer implements IdentityInterface`
`16`	`17`	`{`
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@`
`9`	`9`
`10`	`10`	`/**`
`11`	`11`	`* @SuppressWarnings(PHPMD.LongVariable)`
	`12`	`+ * @api`
`12`	`13`	`*/`
`13`	`14`	`class AttributeSelector extends \Magento\Backend\Block\Template`
`14`	`15`	`{`
Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,7 @@`
`13`	`13`
`14`	`14`	`/**`
`15`	`15`	`* @SuppressWarnings(PHPMD.CouplingBetweenObjects)`
	`16`	`+ * @api`
`16`	`17`	`*/`
`17`	`18`	`class Configurable extends \Magento\Catalog\Block\Product\View\AbstractView`
`18`	`19`	`{`