Merge pull request #1034 from magento-firedrakes/MAGETWO-67477

Alexander Akimov · web-flow · commit 404a1a085923 · 2017-04-21T13:09:49.000+03:00
[Firedrakes] MAGETWO-67477: Add @api annotation to Sales module
diff --git a/app/code/Magento/Sales/Block/Adminhtml/Items/AbstractItems.php b/app/code/Magento/Sales/Block/Adminhtml/Items/AbstractItems.php
@@ -11,6 +11,7 @@
 /**
  * Abstract items renderer
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
+ * @api
  */
 class AbstractItems extends \Magento\Backend\Block\Template
 {
diff --git a/app/code/Magento/Sales/Model/Config/Ordered.php b/app/code/Magento/Sales/Model/Config/Ordered.php
@@ -10,6 +10,7 @@
 
 /**
  * Configuration class for ordered items
+ * @api
  *
  * @author      Magento Core Team <core@magentocommerce.com>
  */
diff --git a/app/code/Magento/Sales/Model/Config/Source/Order/Status.php b/app/code/Magento/Sales/Model/Config/Source/Order/Status.php
@@ -9,6 +9,10 @@
  */
 namespace Magento\Sales\Model\Config\Source\Order;
 
+/**
+ * Class Status
+ * @api
+ */
 class Status implements \Magento\Framework\Option\ArrayInterface
 {
     const UNDEFINED_OPTION_LABEL = '-- Please Select --';
diff --git a/app/code/Magento/Sales/Model/ConfigInterface.php b/app/code/Magento/Sales/Model/ConfigInterface.php
@@ -5,6 +5,10 @@
  */
 namespace Magento\Sales\Model;
 
+/**
+ * Interface ConfigInterface
+ * @api
+ */
 interface ConfigInterface
 {
     /**
diff --git a/app/code/Magento/Sales/Model/EntityInterface.php b/app/code/Magento/Sales/Model/EntityInterface.php
@@ -8,6 +8,7 @@
 
 /**
  * Interface EntityInterface
+ * @api
  */
 interface EntityInterface
 {
diff --git a/app/code/Magento/Sales/Model/Increment.php b/app/code/Magento/Sales/Model/Increment.php
@@ -9,6 +9,7 @@
 
 /**
  * Class Increment
+ * @deprecated 
  */
 class Increment
 {
diff --git a/app/code/Magento/Sales/Model/Order/Address/Renderer.php b/app/code/Magento/Sales/Model/Order/Address/Renderer.php
@@ -12,6 +12,7 @@
 
 /**
  * Class Renderer used for formatting an order address
+ * @api
  */
 class Renderer
 {
diff --git a/app/code/Magento/Sales/Model/Order/Config.php b/app/code/Magento/Sales/Model/Order/Config.php
@@ -7,6 +7,7 @@
 
 /**
  * Order configuration model
+ * @api
  */
 class Config
 {
diff --git a/app/code/Magento/Sales/Model/Order/Creditmemo/Total/AbstractTotal.php b/app/code/Magento/Sales/Model/Order/Creditmemo/Total/AbstractTotal.php
@@ -7,6 +7,7 @@
 
 /**
  * Base class for credit memo total
+ * @api
  *
  * @author      Magento Core Team <core@magentocommerce.com>
  */
diff --git a/app/code/Magento/Sales/Model/Order/Email/Container/Container.php b/app/code/Magento/Sales/Model/Order/Email/Container/Container.php
@@ -9,6 +9,11 @@
 use Magento\Store\Model\Store;
 use Magento\Store\Model\StoreManagerInterface;
 
+/**
+ * Class Container
+ *
+ * @api
+ */
 abstract class Container implements IdentityInterface
 {
     /**
diff --git a/app/code/Magento/Sales/Model/Order/Email/NotifySender.php b/app/code/Magento/Sales/Model/Order/Email/NotifySender.php
@@ -10,6 +10,10 @@
 
 use Magento\Sales\Model\Order;
 
+/**
+ * Class NotifySender
+ * @api
+ */
 abstract class NotifySender extends Sender
 {
     /**
diff --git a/app/code/Magento/Sales/Model/Order/Email/Sender.php b/app/code/Magento/Sales/Model/Order/Email/Sender.php
@@ -10,6 +10,11 @@
 use Magento\Sales\Model\Order\Email\Container\Template;
 use Magento\Sales\Model\Order\Address\Renderer;
 
+/**
+ * Class Sender
+ * @api
+ *
+ */
 abstract class Sender
 {
     /**
diff --git a/app/code/Magento/Sales/Model/Order/Invoice/Total/AbstractTotal.php b/app/code/Magento/Sales/Model/Order/Invoice/Total/AbstractTotal.php
@@ -7,7 +7,7 @@
 
 /**
  * Base class for invoice total
- *
+ * @api
  * @author      Magento Core Team <core@magentocommerce.com>
  */
 abstract class AbstractTotal extends \Magento\Sales\Model\Order\Total\AbstractTotal
diff --git a/app/code/Magento/Sales/Model/Order/Payment/Operations/AbstractOperation.php b/app/code/Magento/Sales/Model/Order/Payment/Operations/AbstractOperation.php
@@ -13,6 +13,9 @@
 use Magento\Sales\Model\Order\Payment\Transaction\BuilderInterface;
 use Magento\Sales\Model\Order\Payment\Transaction\ManagerInterface;
 
+/**
+ * Class AbstractOperation
+ */
 abstract class AbstractOperation
 {
     /**
diff --git a/app/code/Magento/Sales/Model/Order/Pdf/Config.php b/app/code/Magento/Sales/Model/Order/Pdf/Config.php
@@ -7,6 +7,9 @@
  */
 namespace Magento\Sales\Model\Order\Pdf;
 
+/**
+ * Class Config
+ */
 class Config
 {
     /**
diff --git a/app/code/Magento/Sales/Model/Order/Pdf/ItemsFactory.php b/app/code/Magento/Sales/Model/Order/Pdf/ItemsFactory.php
@@ -7,6 +7,8 @@
 
 /**
  * Factory class for \Magento\Sales\Model\Order\Pdf\Items\AbstractItems
+ *
+ * @internal
  */
 class ItemsFactory
 {
diff --git a/app/code/Magento/Sales/Model/Order/Total/AbstractTotal.php b/app/code/Magento/Sales/Model/Order/Total/AbstractTotal.php
@@ -7,7 +7,8 @@
 
 /**
  * Base class for configure totals order
- *
+ * @api
+ * 
  * @author      Magento Core Team <core@magentocommerce.com>
  */
 abstract class AbstractTotal extends \Magento\Framework\DataObject
diff --git a/app/code/Magento/Sales/Model/ResourceModel/AbstractGrid.php b/app/code/Magento/Sales/Model/ResourceModel/AbstractGrid.php
@@ -10,6 +10,7 @@
 
 /**
  * Class AbstractGrid
+ * @api
  */
 abstract class AbstractGrid extends AbstractDb implements GridInterface
 {
diff --git a/app/code/Magento/Sales/Model/ResourceModel/EntityAbstract.php b/app/code/Magento/Sales/Model/ResourceModel/EntityAbstract.php
@@ -14,6 +14,7 @@
 /**
  * Abstract sales entity provides to its children knowledge about eventPrefix and eventObject
  *
+ * @api
  * @SuppressWarnings(PHPMD.NumberOfChildren)
  */
 abstract class EntityAbstract extends AbstractDb
diff --git a/app/code/Magento/Sales/Model/ResourceModel/GridInterface.php b/app/code/Magento/Sales/Model/ResourceModel/GridInterface.php
@@ -7,6 +7,7 @@
 namespace Magento\Sales\Model\ResourceModel;
 
 /**
+ * @api
  * Interface GridInterface
  */
 interface GridInterface
diff --git a/app/code/Magento/Sales/Model/ResourceModel/GridPool.php b/app/code/Magento/Sales/Model/ResourceModel/GridPool.php
@@ -8,6 +8,7 @@
 
 /**
  * Class GridPool
+ * @api
  */
 class GridPool
 {
diff --git a/app/code/Magento/Sales/Model/Status/ListFactory.php b/app/code/Magento/Sales/Model/Status/ListFactory.php
@@ -5,6 +5,10 @@
  */
 namespace Magento\Sales\Model\Status;
 
+/**
+ * Class ListFactory
+ * @internal
+ */
 class ListFactory
 {
     /**
diff --git a/app/code/Magento/SalesSequence/Model/Builder.php b/app/code/Magento/SalesSequence/Model/Builder.php
@@ -13,6 +13,8 @@
 
 /**
  * Class Builder
+ *
+ * @api
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
 class Builder
diff --git a/app/code/Magento/SalesSequence/Model/Config.php b/app/code/Magento/SalesSequence/Model/Config.php
@@ -7,6 +7,8 @@
 
 /**
  * Class Config - configuration container for sequence
+ *
+ * @api
  */
 class Config
 {
diff --git a/app/code/Magento/SalesSequence/Model/Manager.php b/app/code/Magento/SalesSequence/Model/Manager.php
@@ -9,6 +9,7 @@
 
 /**
  * Class Manager
+ * @api
  */
 class Manager
 {
diff --git a/app/code/Magento/SalesSequence/Model/Meta.php b/app/code/Magento/SalesSequence/Model/Meta.php
@@ -9,6 +9,8 @@
 
 /**
  * Class Meta
+ *
+ * @api
  */
 class Meta extends AbstractModel
 {
diff --git a/app/code/Magento/SalesSequence/Model/Profile.php b/app/code/Magento/SalesSequence/Model/Profile.php
@@ -9,6 +9,8 @@
 
 /**
  * Class Profile
+ *
+ * @api
  */
 class Profile extends AbstractModel
 {
diff --git a/app/code/Magento/SalesSequence/Model/ResourceModel/Meta.php b/app/code/Magento/SalesSequence/Model/ResourceModel/Meta.php
@@ -14,6 +14,8 @@
 
 /**
  * Class Meta represents metadata for sequence as sequence table and store id
+ *
+ * @api
  */
 class Meta extends \Magento\Framework\Model\ResourceModel\Db\AbstractDb
 {
diff --git a/app/code/Magento/SalesSequence/Model/ResourceModel/Profile.php b/app/code/Magento/SalesSequence/Model/ResourceModel/Profile.php
@@ -11,6 +11,8 @@
 
 /**
  * Class Profile represents profile data for sequence as prefix, suffix, start value etc.
+ *
+ * @api
  */
 class Profile extends \Magento\Framework\Model\ResourceModel\Db\AbstractDb
 {
diff --git a/app/code/Magento/SalesSequence/Model/Sequence.php b/app/code/Magento/SalesSequence/Model/Sequence.php
@@ -10,6 +10,8 @@
 
 /**
  * Class Sequence represents sequence in logic
+ *
+ * @api
  */
 class Sequence implements SequenceInterface
 {
diff --git a/app/code/Magento/Shipping/Model/Carrier/AbstractCarrier.php b/app/code/Magento/Shipping/Model/Carrier/AbstractCarrier.php
@@ -13,6 +13,8 @@
 
 /**
  * Class AbstractCarrier
+ *
+ * @api
  */
 abstract class AbstractCarrier extends \Magento\Framework\DataObject implements AbstractCarrierInterface
 {
diff --git a/app/code/Magento/Shipping/Model/Config.php b/app/code/Magento/Shipping/Model/Config.php
@@ -8,6 +8,10 @@
 
 namespace Magento\Shipping\Model;
 
+/**
+ * Class Config
+ * @api
+ */
 class Config extends \Magento\Framework\DataObject
 {
     /**
diff --git a/app/code/Magento/Shipping/Model/Rate/Result.php b/app/code/Magento/Shipping/Model/Rate/Result.php
@@ -5,6 +5,12 @@
  */
 namespace Magento\Shipping\Model\Rate;
 
+/**
+ * Class Result
+ * Container for Rates
+ *
+ * @api
+ */
 class Result
 {
     /**

Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,7 @@`
`11`	`11`	`/**`
`12`	`12`	`* Abstract items renderer`
`13`	`13`	`* @SuppressWarnings(PHPMD.CouplingBetweenObjects)`
	`14`	`+ * @api`
`14`	`15`	`*/`
`15`	`16`	`class AbstractItems extends \Magento\Backend\Block\Template`
`16`	`17`	`{`
Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,7 @@`
`10`	`10`
`11`	`11`	`/**`
`12`	`12`	`* Configuration class for ordered items`
	`13`	`+ * @api`
`13`	`14`	`*`
`14`	`15`	`* @author Magento Core Team <[email protected]>`
`15`	`16`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,7 @@`
`8`	`8`
`9`	`9`	`/**`
`10`	`10`	`* Interface EntityInterface`
	`11`	`+ * @api`
`11`	`12`	`*/`
`12`	`13`	`interface EntityInterface`
`13`	`14`	`{`
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@`
`9`	`9`
`10`	`10`	`/**`
`11`	`11`	`* Class Increment`
	`12`	`+ * @deprecated`
`12`	`13`	`*/`
`13`	`14`	`class Increment`
`14`	`15`	`{`
Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@`
`12`	`12`
`13`	`13`	`/**`
`14`	`14`	`* Class Renderer used for formatting an order address`
	`15`	`+ * @api`
`15`	`16`	`*/`
`16`	`17`	`class Renderer`
`17`	`18`	`{`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,7 @@`
`7`	`7`
`8`	`8`	`/**`
`9`	`9`	`* Order configuration model`
	`10`	`+ * @api`
`10`	`11`	`*/`
`11`	`12`	`class Config`
`12`	`13`	`{`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,7 @@`
`7`	`7`
`8`	`8`	`/**`
`9`	`9`	`* Base class for credit memo total`
	`10`	`+ * @api`
`10`	`11`	`*`
`11`	`12`	`* @author Magento Core Team <[email protected]>`
`12`	`13`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,10 @@`
`10`	`10`
`11`	`11`	`use Magento\Sales\Model\Order;`
`12`	`12`
	`13`	`+/**`
	`14`	`+ * Class NotifySender`
	`15`	`+ * @api`
	`16`	`+ */`
`13`	`17`	`abstract class NotifySender extends Sender`
`14`	`18`	`{`
`15`	`19`	`/**`
-Original file line number
+Diff line change
 /**
  * Base class for invoice total
 - *
 + * @api
  * @author      Magento Core Team <[email protected]>
  */
 abstract class AbstractTotal extends \Magento\Sales\Model\Order\Total\AbstractTotal
Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,9 @@`
`13`	`13`	`use Magento\Sales\Model\Order\Payment\Transaction\BuilderInterface;`
`14`	`14`	`use Magento\Sales\Model\Order\Payment\Transaction\ManagerInterface;`
`15`	`15`
	`16`	`+/**`
	`17`	`+ * Class AbstractOperation`
	`18`	`+ */`
`16`	`19`	`abstract class AbstractOperation`
`17`	`20`	`{`
`18`	`21`	`/**`