MAGETWO-67576: Add @api Annotation in Pricing Framework

Igor Melnikov · Igor Melnikov · commit b5f2791554ca · 2017-04-24T16:27:13.000-05:00
- merging with remote tracking branch
diff --git a/lib/internal/Magento/Framework/App/Cache/Manager.php b/lib/internal/Magento/Framework/App/Cache/Manager.php
@@ -10,6 +10,8 @@
 
 /**
  * Cache status manager
+ *
+ * @api
  */
 class Manager
 {
diff --git a/lib/internal/Magento/Framework/App/Cache/Tag/StrategyInterface.php b/lib/internal/Magento/Framework/App/Cache/Tag/StrategyInterface.php
@@ -7,6 +7,8 @@
 
 /**
  * Invalidation tags generator
+ *
+ * @api
  */
 interface StrategyInterface
 {
diff --git a/lib/internal/Magento/Framework/App/Cache/Type/Config.php b/lib/internal/Magento/Framework/App/Cache/Type/Config.php
@@ -4,14 +4,14 @@
  * See COPYING.txt for license details.
  */
 
-/**
- * System / Cache Management / Cache type "Configuration"
- */
 namespace Magento\Framework\App\Cache\Type;
 
 use Magento\Framework\Cache\Frontend\Decorator\TagScope;
 use Magento\Framework\Config\CacheInterface;
 
+/**
+ * System / Cache Management / Cache type "Configuration"
+ */
 class Config extends TagScope implements CacheInterface
 {
     /**
diff --git a/lib/internal/Magento/Framework/App/Cache/Type/FrontendPool.php b/lib/internal/Magento/Framework/App/Cache/Type/FrontendPool.php
@@ -10,6 +10,8 @@
 
 /**
  * In-memory readonly pool of cache front-ends with enforced access control, specific to cache types
+ *
+ * @api
  */
 class FrontendPool
 {
diff --git a/lib/internal/Magento/Framework/Cache/Backend/Decorator/AbstractDecorator.php b/lib/internal/Magento/Framework/Cache/Backend/Decorator/AbstractDecorator.php
@@ -4,11 +4,11 @@
  * See COPYING.txt for license details.
  */
 
+namespace Magento\Framework\Cache\Backend\Decorator;
+
 /**
  * Abstract decorator class for \Zend_Cache_Backend class and its descendants
  */
-namespace Magento\Framework\Cache\Backend\Decorator;
-
 abstract class AbstractDecorator extends \Zend_Cache_Backend implements \Zend_Cache_Backend_ExtendedInterface
 {
     /**
diff --git a/lib/internal/Magento/Framework/Cache/Backend/Decorator/Compression.php b/lib/internal/Magento/Framework/Cache/Backend/Decorator/Compression.php
@@ -4,13 +4,13 @@
  * See COPYING.txt for license details.
  */
 
+namespace Magento\Framework\Cache\Backend\Decorator;
+
 /**
  * Decorator class for compressing data before storing in cache
  *
  * @todo re-implement as a cache frontend decorator similarly to \Magento\Framework\Cache\Frontend\Decorator\*
  */
-namespace Magento\Framework\Cache\Backend\Decorator;
-
 class Compression extends \Magento\Framework\Cache\Backend\Decorator\AbstractDecorator
 {
     /**
diff --git a/lib/internal/Magento/Framework/Cache/Frontend/Decorator/Logger.php b/lib/internal/Magento/Framework/Cache/Frontend/Decorator/Logger.php
@@ -4,14 +4,14 @@
  * See COPYING.txt for license details.
  */
 
-/**
- * Cache frontend decorator that logger of cache invalidate
- */
 namespace Magento\Framework\Cache\Frontend\Decorator;
 
 use Magento\Framework\Cache\FrontendInterface;
 use Magento\Framework\Cache\InvalidateLogger as LoggerHandler;
 
+/**
+ * Cache frontend decorator that logs cache invalidation actions
+ */
 class Logger extends Bare
 {
     /**
diff --git a/lib/internal/Magento/Framework/Cache/Frontend/Decorator/Profiler.php b/lib/internal/Magento/Framework/Cache/Frontend/Decorator/Profiler.php
@@ -4,11 +4,11 @@
  * See COPYING.txt for license details.
  */
 
+namespace Magento\Framework\Cache\Frontend\Decorator;
+
 /**
  * Cache frontend decorator that performs profiling of cache operations
  */
-namespace Magento\Framework\Cache\Frontend\Decorator;
-
 class Profiler extends \Magento\Framework\Cache\Frontend\Decorator\Bare
 {
     /**
diff --git a/lib/internal/Magento/Framework/Cache/Frontend/Decorator/TagScope.php b/lib/internal/Magento/Framework/Cache/Frontend/Decorator/TagScope.php
@@ -4,11 +4,13 @@
  * See COPYING.txt for license details.
  */
 
+namespace Magento\Framework\Cache\Frontend\Decorator;
+
 /**
  * Cache frontend decorator that limits the cleaning scope within a tag
+ *
+ * @api
  */
-namespace Magento\Framework\Cache\Frontend\Decorator;
-
 class TagScope extends \Magento\Framework\Cache\Frontend\Decorator\Bare
 {
     /**
diff --git a/lib/internal/Magento/Framework/Cache/FrontendInterface.php b/lib/internal/Magento/Framework/Cache/FrontendInterface.php
@@ -4,11 +4,13 @@
  * See COPYING.txt for license details.
  */
 
+namespace Magento\Framework\Cache;
+
 /**
  * Interface of a cache frontend - an ultimate publicly available interface to an actual cache storage
+ *
+ * @api
  */
-namespace Magento\Framework\Cache;
-
 interface FrontendInterface
 {
     /**
diff --git a/lib/internal/Magento/Framework/Mail/Template/TransportBuilder.php b/lib/internal/Magento/Framework/Mail/Template/TransportBuilder.php
@@ -9,11 +9,13 @@
 namespace Magento\Framework\Mail\Template;
 
 use Magento\Framework\App\TemplateTypesInterface;
-use Magento\Framework\Mail\Message;
 use Magento\Framework\Mail\MessageInterface;
 use Magento\Framework\Mail\TransportInterfaceFactory;
 use Magento\Framework\ObjectManagerInterface;
 
+/**
+ * @api
+ */
 class TransportBuilder
 {
     /**
diff --git a/lib/internal/Magento/Framework/Pricing/Adjustment/Collection.php b/lib/internal/Magento/Framework/Pricing/Adjustment/Collection.php
@@ -8,6 +8,8 @@
 
 /**
  * Adjustment collection model
+ *
+ * @api
  */
 class Collection
 {
diff --git a/lib/internal/Magento/Framework/Pricing/Adjustment/Pool.php b/lib/internal/Magento/Framework/Pricing/Adjustment/Pool.php
@@ -10,6 +10,8 @@
 
 /**
  * Global adjustment pool model
+ *
+ * @api
  */
 class Pool
 {
diff --git a/lib/internal/Magento/Framework/Pricing/Amount/AmountFactory.php b/lib/internal/Magento/Framework/Pricing/Amount/AmountFactory.php
@@ -8,6 +8,8 @@
 
 /**
  * Class AmountFactory
+ *
+ * @api
  */
 class AmountFactory
 {
diff --git a/lib/internal/Magento/Framework/Pricing/Helper/Data.php b/lib/internal/Magento/Framework/Pricing/Helper/Data.php
@@ -9,6 +9,8 @@
 
 /**
  * Pricing data helper
+ * 
+ * @api
  */
 class Data extends \Magento\Framework\App\Helper\AbstractHelper
 {
diff --git a/lib/internal/Magento/Framework/Pricing/Price/AbstractPrice.php b/lib/internal/Magento/Framework/Pricing/Price/AbstractPrice.php
@@ -14,6 +14,8 @@
 /**
  * Class AbstractPrice
  * Should be the base for creating any Price type class
+ *
+ * @api
  */
 abstract class AbstractPrice implements PriceInterface
 {
diff --git a/lib/internal/Magento/Framework/Pricing/Price/Collection.php b/lib/internal/Magento/Framework/Pricing/Price/Collection.php
@@ -10,6 +10,8 @@
 
 /**
  * Class Collection
+ *
+ * @api
  */
 class Collection implements \Iterator
 {
diff --git a/lib/internal/Magento/Framework/Pricing/Price/Pool.php b/lib/internal/Magento/Framework/Pricing/Price/Pool.php
@@ -8,6 +8,8 @@
 
 /**
  * Class Pool
+ *
+ * @api
  */
 class Pool implements \Iterator, \ArrayAccess
 {
diff --git a/lib/internal/Magento/Framework/Pricing/PriceComposite.php b/lib/internal/Magento/Framework/Pricing/PriceComposite.php
@@ -6,7 +6,6 @@
 
 namespace Magento\Framework\Pricing;
 
-use Magento\Framework\Pricing\SaleableInterface;
 use Magento\Framework\Pricing\Price\Factory as PriceFactory;
 use Magento\Framework\Pricing\Price\PriceInterface;
 
diff --git a/lib/internal/Magento/Framework/Pricing/PriceInfo/Base.php b/lib/internal/Magento/Framework/Pricing/PriceInfo/Base.php
@@ -15,6 +15,8 @@
 /**
  * Class Base
  * Price info base model
+ *
+ * @api
  */
 class Base implements PriceInfoInterface
 {
diff --git a/lib/internal/Magento/Framework/Pricing/PriceInfo/Factory.php b/lib/internal/Magento/Framework/Pricing/PriceInfo/Factory.php
@@ -14,6 +14,8 @@
 
 /**
  * Price info model factory
+ *
+ * @api
  */
 class Factory
 {
diff --git a/lib/internal/Magento/Framework/Pricing/Render.php b/lib/internal/Magento/Framework/Pricing/Render.php
@@ -7,7 +7,6 @@
 namespace Magento\Framework\Pricing;
 
 use Magento\Framework\Pricing\Amount\AmountInterface;
-use Magento\Framework\Pricing\SaleableInterface;
 use Magento\Framework\Pricing\Price\PriceInterface;
 use Magento\Framework\Pricing\Render\Layout;
 use Magento\Framework\View\Element\AbstractBlock;
@@ -17,6 +16,8 @@
  * Base price render
  *
  * @method string getPriceRenderHandle()
+ *
+ * @api
  */
 class Render extends AbstractBlock
 {
diff --git a/lib/internal/Magento/Framework/Pricing/Render/RendererPool.php b/lib/internal/Magento/Framework/Pricing/Render/RendererPool.php
@@ -13,6 +13,8 @@
 
 /**
  * RenderPool
+ *
+ * @api
  */
 class RendererPool extends AbstractBlock
 {
@@ -77,9 +79,8 @@ public function createPriceRender(
         $renderBlock = $this->getLayout()->createBlock($renderClassName, '', $arguments);
         if (!$renderBlock instanceof PriceBoxRenderInterface) {
             throw new \InvalidArgumentException(
-                'Block "' .
-                $renderClassName .
-                '" must implement \Magento\Framework\Pricing\Render\PriceBoxRenderInterface'
+                'Block "' . $renderClassName
+                . '" must implement \Magento\Framework\Pricing\Render\PriceBoxRenderInterface'
             );
         }
         $renderBlock->setTemplate($this->getRenderBlockTemplate($type, $priceCode));
@@ -142,9 +143,8 @@ public function createAmountRender(
         $amountBlock = $this->getLayout()->createBlock($renderClassName, '', $arguments);
         if (!$amountBlock instanceof AmountRenderInterface) {
             throw new \InvalidArgumentException(
-                'Block "' .
-                $renderClassName .
-                '" must implement \Magento\Framework\Pricing\Render\AmountRenderInterface'
+                'Block "' . $renderClassName
+                . '" must implement \Magento\Framework\Pricing\Render\AmountRenderInterface'
             );
         }
         $amountBlock->setTemplate($this->getAmountRenderBlockTemplate($type, $priceCode));
@@ -158,8 +158,8 @@ public function createAmountRender(
      */
     public function getAdjustmentRenders(SaleableInterface $saleableItem = null, PriceInterface $price = null)
     {
-        $itemType = $saleableItem === null ? 'default' : $saleableItem->getTypeId();
-        $priceType = $price === null ? 'default' : $price->getPriceCode();
+        $itemType = null === $saleableItem ? 'default' : $saleableItem->getTypeId();
+        $priceType = null === $price ? 'default' : $price->getPriceCode();
 
         $fallbackPattern = [
             "{$itemType}/adjustments/{$priceType}",

Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,8 @@`
`10`	`10`
`11`	`11`	`/**`
`12`	`12`	`* Cache status manager`
	`13`	`+ *`
	`14`	`+ * @api`
`13`	`15`	`*/`
`14`	`16`	`class Manager`
`15`	`17`	`{`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,8 @@`
`7`	`7`
`8`	`8`	`/**`
`9`	`9`	`* Invalidation tags generator`
	`10`	`+ *`
	`11`	`+ * @api`
`10`	`12`	`*/`
`11`	`13`	`interface StrategyInterface`
`12`	`14`	`{`