Merge pull request #1053 from magento-nord/MAGETWO-66374

Implemented task: - MAGETWO-66374 Add @api annotation
magento · Apr 24, 2017 · a9e8595 · a9e8595
2 parents e0bd129 + 59931bc
commit a9e8595
Show file tree

Hide file tree

Showing 72 changed files with 157 additions and 29 deletions.
diff --git a/app/code/Magento/CatalogImportExport/Model/Export/Product.php b/app/code/Magento/CatalogImportExport/Model/Export/Product.php
@@ -12,7 +12,8 @@
 /**
  * Export entity product model
  *
- * @author      Magento Core Team <core@magentocommerce.com>
+ * @api
+ *
  * @SuppressWarnings(PHPMD.TooManyFields)
  * @SuppressWarnings(PHPMD.ExcessiveClassComplexity)
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)

diff --git a/app/code/Magento/CatalogImportExport/Model/Export/Product/Type/AbstractType.php b/app/code/Magento/CatalogImportExport/Model/Export/Product/Type/AbstractType.php
@@ -10,7 +10,7 @@
 /**
  * Export entity product type abstract model
  *
- * @author      Magento Core Team <core@magentocommerce.com>
+ * @api
  */
 abstract class AbstractType
 {

diff --git a/app/code/Magento/CatalogImportExport/Model/Export/Product/Type/Simple.php b/app/code/Magento/CatalogImportExport/Model/Export/Product/Type/Simple.php
@@ -8,7 +8,7 @@
 /**
  * Export entity product type simple model
  *
- * @author      Magento Core Team <core@magentocommerce.com>
+ * @api
  */
 class Simple extends \Magento\CatalogImportExport\Model\Export\Product\Type\AbstractType
 {

diff --git a/app/code/Magento/CatalogImportExport/Model/Export/RowCustomizer/Composite.php b/app/code/Magento/CatalogImportExport/Model/Export/RowCustomizer/Composite.php
@@ -8,6 +8,11 @@
 use Magento\CatalogImportExport\Model\Export\RowCustomizerInterface;
 use Magento\Framework\ObjectManagerInterface;
 
+/**
+ * Class Composite
+ *
+ * @api
+ */
 class Composite implements RowCustomizerInterface
 {
     /**

diff --git a/app/code/Magento/CatalogImportExport/Model/Export/RowCustomizerInterface.php b/app/code/Magento/CatalogImportExport/Model/Export/RowCustomizerInterface.php
@@ -7,6 +7,8 @@
 
 /**
  * Interface RowCustomizerInterface
+ *
+ * @api
  */
 interface RowCustomizerInterface
 {

diff --git a/app/code/Magento/CatalogImportExport/Model/Import/Product.php b/app/code/Magento/CatalogImportExport/Model/Import/Product.php
@@ -21,6 +21,9 @@
 
 /**
  * Import entity product model
+ *
+ * @api
+ *
  * @SuppressWarnings(PHPMD.TooManyFields)
  * @SuppressWarnings(PHPMD.ExcessiveClassComplexity)
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)

diff --git a/app/code/Magento/CatalogImportExport/Model/Import/Product/CategoryProcessor.php b/app/code/Magento/CatalogImportExport/Model/Import/Product/CategoryProcessor.php
@@ -5,6 +5,11 @@
  */
 namespace Magento\CatalogImportExport\Model\Import\Product;
 
+/**
+ * Class CategoryProcessor
+ *
+ * @api
+ */
 class CategoryProcessor
 {
     /**

diff --git a/app/code/Magento/CatalogImportExport/Model/Import/Product/Option.php b/app/code/Magento/CatalogImportExport/Model/Import/Product/Option.php
@@ -16,12 +16,11 @@
 /**
  * Entity class which provide possibility to import product custom options
  *
- * @author      Magento Core Team <core@magentocommerce.com>
+ * @api
  *
  * @SuppressWarnings(PHPMD.TooManyFields)
  * @SuppressWarnings(PHPMD.ExcessiveClassComplexity)
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
- * @todo Need to explode this class because of several responsibilities
  */
 class Option extends \Magento\ImportExport\Model\Import\Entity\AbstractEntity
 {

diff --git a/app/code/Magento/CatalogImportExport/Model/Import/Product/RowValidatorInterface.php b/app/code/Magento/CatalogImportExport/Model/Import/Product/RowValidatorInterface.php
@@ -5,6 +5,11 @@
  */
 namespace Magento\CatalogImportExport\Model\Import\Product;
 
+/**
+ * Interface RowValidatorInterface
+ *
+ * @api
+ */
 interface RowValidatorInterface extends \Magento\Framework\Validator\ValidatorInterface
 {
     const ERROR_INVALID_SCOPE = 'invalidScope';

diff --git a/app/code/Magento/CatalogImportExport/Model/Import/Product/SkuProcessor.php b/app/code/Magento/CatalogImportExport/Model/Import/Product/SkuProcessor.php
@@ -5,6 +5,11 @@
  */
 namespace Magento\CatalogImportExport\Model\Import\Product;
 
+/**
+ * Class SkuProcessor
+ *
+ * @api
+ */
 class SkuProcessor
 {
     /**

diff --git a/app/code/Magento/CatalogImportExport/Model/Import/Product/Type/AbstractType.php b/app/code/Magento/CatalogImportExport/Model/Import/Product/Type/AbstractType.php
@@ -13,6 +13,8 @@
 /**
  * Import entity abstract product type model
  *
+ * @api
+ *
  * @SuppressWarnings(PHPMD.TooManyFields)
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */

diff --git a/app/code/Magento/CatalogImportExport/Model/Import/Product/Type/Simple.php b/app/code/Magento/CatalogImportExport/Model/Import/Product/Type/Simple.php
@@ -8,7 +8,7 @@
 /**
  * Import entity simple product type
  *
- * @author      Magento Core Team <core@magentocommerce.com>
+ * @api
  */
 class Simple extends \Magento\CatalogImportExport\Model\Import\Product\Type\AbstractType
 {

diff --git a/app/code/Magento/CatalogImportExport/Model/Import/Product/Type/Virtual.php b/app/code/Magento/CatalogImportExport/Model/Import/Product/Type/Virtual.php
@@ -8,7 +8,7 @@
 /**
  * Import entity virtual product type
  *
- * @author      Magento Core Team <core@magentocommerce.com>
+ * @api
  */
 class Virtual extends \Magento\CatalogImportExport\Model\Import\Product\Type\Simple
 {

diff --git a/app/code/Magento/CatalogImportExport/Model/Import/Product/Validator.php b/app/code/Magento/CatalogImportExport/Model/Import/Product/Validator.php
@@ -8,6 +8,11 @@
 use Magento\CatalogImportExport\Model\Import\Product;
 use Magento\Framework\Validator\AbstractValidator;
 
+/**
+ * Class Validator
+ *
+ * @api
+ */
 class Validator extends AbstractValidator implements RowValidatorInterface
 {
     /**

diff --git a/app/code/Magento/CatalogImportExport/Model/Import/Uploader.php b/app/code/Magento/CatalogImportExport/Model/Import/Uploader.php
@@ -11,7 +11,7 @@
 /**
  * Import entity product model
  *
- * @author      Magento Core Team <core@magentocommerce.com>
+ * @api
  */
 class Uploader extends \Magento\MediaStorage\Model\File\Uploader
 {

diff --git a/app/code/Magento/CustomerImportExport/Model/Export/Address.php b/app/code/Magento/CustomerImportExport/Model/Export/Address.php
@@ -6,6 +6,10 @@
 namespace Magento\CustomerImportExport\Model\Export;
 
 /**
+ * Customer address export
+ *
+ * @api
+ *
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
 class Address extends \Magento\ImportExport\Model\Export\Entity\AbstractEav

diff --git a/app/code/Magento/CustomerImportExport/Model/Export/Customer.php b/app/code/Magento/CustomerImportExport/Model/Export/Customer.php
@@ -8,6 +8,8 @@
 /**
  * Export entity customer model
  *
+ * @api
+ *
  * @method \Magento\Customer\Model\ResourceModel\Attribute\Collection getAttributeCollection() getAttributeCollection()
  */
 class Customer extends \Magento\ImportExport\Model\Export\Entity\AbstractEav

diff --git a/app/code/Magento/CustomerImportExport/Model/Import/AbstractCustomer.php b/app/code/Magento/CustomerImportExport/Model/Import/AbstractCustomer.php
@@ -10,6 +10,9 @@
 
 /**
  * Import entity abstract customer model
+ *
+ * @api
+ *
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
 abstract class AbstractCustomer extends \Magento\ImportExport\Model\Import\Entity\AbstractEav

diff --git a/app/code/Magento/CustomerImportExport/Model/Import/Address.php b/app/code/Magento/CustomerImportExport/Model/Import/Address.php
@@ -8,6 +8,8 @@
 use Magento\ImportExport\Model\Import\ErrorProcessing\ProcessingErrorAggregatorInterface;
 
 /**
+ * Customer address import
+ *
  * @SuppressWarnings(PHPMD.TooManyFields)
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */

diff --git a/app/code/Magento/CustomerImportExport/Model/Import/Customer.php b/app/code/Magento/CustomerImportExport/Model/Import/Customer.php
@@ -9,6 +9,10 @@
 use Magento\ImportExport\Model\Import\ErrorProcessing\ProcessingErrorAggregatorInterface;
 
 /**
+ * Customer entity import
+ *
+ * @api
+ *
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
 class Customer extends AbstractCustomer

diff --git a/app/code/Magento/ImportExport/Helper/Data.php b/app/code/Magento/ImportExport/Helper/Data.php
@@ -11,7 +11,7 @@
 /**
  * ImportExport data helper
  *
- * @author      Magento Core Team <core@magentocommerce.com>
+ * @api
  */
 class Data extends \Magento\Framework\App\Helper\AbstractHelper
 {

diff --git a/app/code/Magento/ImportExport/Helper/Report.php b/app/code/Magento/ImportExport/Helper/Report.php
@@ -12,6 +12,8 @@
 
 /**
  * ImportExport history reports helper
+ *
+ * @api
  */
 class Report extends \Magento\Framework\App\Helper\AbstractHelper
 {

diff --git a/app/code/Magento/ImportExport/Model/Export.php b/app/code/Magento/ImportExport/Model/Export.php
@@ -11,7 +11,8 @@
 /**
  * Export model
  *
- * @author      Magento Core Team <core@magentocommerce.com>
+ * @api
+ *
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
 class Export extends \Magento\ImportExport\Model\AbstractModel

diff --git a/app/code/Magento/ImportExport/Model/Export/AbstractEntity.php b/app/code/Magento/ImportExport/Model/Export/AbstractEntity.php
@@ -12,7 +12,8 @@
 /**
  * Export entity abstract model
  *
- * @author      Magento Core Team <core@magentocommerce.com>
+ * @api
+ *
  * @SuppressWarnings(PHPMD.TooManyFields)
  */
 abstract class AbstractEntity

diff --git a/app/code/Magento/ImportExport/Model/Export/Adapter/AbstractAdapter.php b/app/code/Magento/ImportExport/Model/Export/Adapter/AbstractAdapter.php
@@ -11,7 +11,7 @@
 /**
  * Abstract adapter model
  *
- * @author      Magento Core Team <core@magentocommerce.com>
+ * @api
  */
 abstract class AbstractAdapter
 {

diff --git a/app/code/Magento/ImportExport/Model/Export/Adapter/Csv.php b/app/code/Magento/ImportExport/Model/Export/Adapter/Csv.php
@@ -8,7 +8,7 @@
 /**
  * Export adapter csv.
  *
- * @author      Magento Core Team <core@magentocommerce.com>
+ * @api
  */
 class Csv extends \Magento\ImportExport\Model\Export\Adapter\AbstractAdapter
 {

diff --git a/app/code/Magento/ImportExport/Model/Export/ConfigInterface.php b/app/code/Magento/ImportExport/Model/Export/ConfigInterface.php
@@ -5,6 +5,11 @@
  */
 namespace Magento\ImportExport\Model\Export;
 
+/**
+ * Provides export configuration
+ *
+ * @api
+ */
 interface ConfigInterface
 {
     /**

diff --git a/app/code/Magento/ImportExport/Model/Export/Entity/AbstractEav.php b/app/code/Magento/ImportExport/Model/Export/Entity/AbstractEav.php
@@ -13,7 +13,8 @@
 /**
  * Export EAV entity abstract model
  *
- * @author      Magento Core Team <core@magentocommerce.com>
+ * @api
+ *
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
 abstract class AbstractEav extends \Magento\ImportExport\Model\Export\AbstractEntity

diff --git a/app/code/Magento/ImportExport/Model/Export/Entity/AbstractEntity.php b/app/code/Magento/ImportExport/Model/Export/Entity/AbstractEntity.php
@@ -11,7 +11,8 @@
 /**
  * Export entity abstract model
  *
- * @author      Magento Core Team <core@magentocommerce.com>
+ * @api
+ *
  * @SuppressWarnings(PHPMD.TooManyFields)
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */

diff --git a/app/code/Magento/ImportExport/Model/History.php b/app/code/Magento/ImportExport/Model/History.php
@@ -8,6 +8,8 @@
 /**
  * Import history model
  *
+ * @api
+ *
  * @method \Magento\ImportExport\Model\ResourceModel\History _getResource()
  * @method \Magento\ImportExport\Model\ResourceModel\History getResource()
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)

diff --git a/app/code/Magento/ImportExport/Model/Import.php b/app/code/Magento/ImportExport/Model/Import.php
@@ -16,7 +16,7 @@
 /**
  * Import model
  *
- * @author      Magento Core Team <core@magentocommerce.com>
+ * @api
  *
  * @method string getBehavior() getBehavior()
  * @method \Magento\ImportExport\Model\Import setEntity() setEntity(string $value)

diff --git a/app/code/Magento/ImportExport/Model/Import/AbstractEntity.php b/app/code/Magento/ImportExport/Model/Import/AbstractEntity.php
@@ -13,6 +13,9 @@
 
 /**
  * Import entity abstract model
+ *
+ * @api
+ *
  * @SuppressWarnings(PHPMD.TooManyFields)
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */

diff --git a/app/code/Magento/ImportExport/Model/Import/AbstractSource.php b/app/code/Magento/ImportExport/Model/Import/AbstractSource.php
@@ -9,6 +9,8 @@
 
 /**
  * Data source with columns for Magento_ImportExport
+ *
+ * @api
  */
 abstract class AbstractSource implements \SeekableIterator
 {

diff --git a/app/code/Magento/ImportExport/Model/Import/ConfigInterface.php b/app/code/Magento/ImportExport/Model/Import/ConfigInterface.php
@@ -5,6 +5,11 @@
  */
 namespace Magento\ImportExport\Model\Import;
 
+/**
+ * Provides import configuration
+ *
+ * @api
+ */
 interface ConfigInterface
 {
     /**

diff --git a/app/code/Magento/ImportExport/Model/Import/Entity/AbstractEav.php b/app/code/Magento/ImportExport/Model/Import/Entity/AbstractEav.php
@@ -9,6 +9,9 @@
 
 /**
  * Import EAV entity abstract model
+ *
+ * @api
+ *
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
 abstract class AbstractEav extends \Magento\ImportExport\Model\Import\AbstractEntity

diff --git a/app/code/Magento/ImportExport/Model/Import/Entity/AbstractEntity.php b/app/code/Magento/ImportExport/Model/Import/Entity/AbstractEntity.php
@@ -15,6 +15,9 @@
 
 /**
  * Import entity abstract model
+ *
+ * @api
+ *
  * @SuppressWarnings(PHPMD.TooManyFields)
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */

diff --git a/app/code/Magento/ImportExport/Model/Import/ErrorProcessing/ProcessingError.php b/app/code/Magento/ImportExport/Model/Import/ErrorProcessing/ProcessingError.php
@@ -8,6 +8,8 @@
 
 /**
  * Class describe Processing Error
+ *
+ * @api
  */
 class ProcessingError
 {

diff --git a/.../Magento/ImportExport/Model/Import/ErrorProcessing/ProcessingErrorAggregatorInterface.php b/.../Magento/ImportExport/Model/Import/ErrorProcessing/ProcessingErrorAggregatorInterface.php
@@ -8,6 +8,8 @@
 
 /**
  * Interface for Processing errors Aggregator
+ *
+ * @api
  */
 interface ProcessingErrorAggregatorInterface
 {

diff --git a/app/code/Magento/ImportExport/Model/ResourceModel/CollectionByPagesIterator.php b/app/code/Magento/ImportExport/Model/ResourceModel/CollectionByPagesIterator.php
@@ -8,7 +8,7 @@
 /**
  * Collection by pages iterator
  *
- * @author      Magento Core Team <core@magentocommerce.com>
+ * @api
  */
 class CollectionByPagesIterator
 {

diff --git a/app/code/Magento/ImportExport/Model/ResourceModel/Helper.php b/app/code/Magento/ImportExport/Model/ResourceModel/Helper.php
@@ -7,7 +7,7 @@
 /**
  * ImportExport MySQL resource helper model
  *
- * @author      Magento Core Team <core@magentocommerce.com>
+ * @api
  */
 namespace Magento\ImportExport\Model\ResourceModel;
-Original file line number
+Diff line change
@@ Expand Up / @@ -10,7 +10,7 @@ @@
     /**
      * Export entity product type abstract model
      *
-     * @author      Magento Core Team <core@magentocommerce.com>
+     * @api
      */
     abstract class AbstractType
     {
@@ Expand Down @@