MAGETWO-66657: Add @api Annotation for Downloadable Module

Yaroslav Onischenko · Yaroslav Onischenko · commit fb504158d617 · 2017-04-14T16:48:22.000+03:00
diff --git a/app/code/Magento/Downloadable/Block/Catalog/Product/Links.php b/app/code/Magento/Downloadable/Block/Catalog/Product/Links.php
@@ -12,6 +12,7 @@
 
 /**
  * Downloadable Product Links part block
+ * @api
  */
 class Links extends \Magento\Catalog\Block\Product\AbstractProduct
 {
diff --git a/app/code/Magento/Downloadable/Block/Catalog/Product/Samples.php b/app/code/Magento/Downloadable/Block/Catalog/Product/Samples.php
@@ -13,7 +13,7 @@
 /**
  * Downloadable Product Samples part block
  *
- * @author      Magento Core Team <core@magentocommerce.com>
+ * @api
  */
 class Samples extends \Magento\Catalog\Block\Product\AbstractProduct
 {
diff --git a/app/code/Magento/Downloadable/Block/Catalog/Product/View/Type.php b/app/code/Magento/Downloadable/Block/Catalog/Product/View/Type.php
@@ -11,6 +11,9 @@
  */
 namespace Magento\Downloadable\Block\Catalog\Product\View;
 
+/**
+ * @api
+ */
 class Type extends \Magento\Catalog\Block\Product\View\Type\Virtual
 {
 }
diff --git a/app/code/Magento/Downloadable/Block/Checkout/Cart/Item/Renderer.php b/app/code/Magento/Downloadable/Block/Checkout/Cart/Item/Renderer.php
@@ -14,6 +14,9 @@
 use Magento\Framework\Pricing\PriceCurrencyInterface;
 use Magento\Framework\View\Element\Message\InterpretationStrategyInterface;
 
+/**
+ * @api
+ */
 class Renderer extends \Magento\Checkout\Block\Cart\Item\Renderer
 {
     /**
diff --git a/app/code/Magento/Downloadable/Block/Checkout/Success.php b/app/code/Magento/Downloadable/Block/Checkout/Success.php
@@ -13,6 +13,9 @@
 
 use Magento\Framework\View\Element\Template;
 
+/**
+ * @api
+ */
 class Success extends \Magento\Checkout\Block\Onepage\Success
 {
     /**
diff --git a/app/code/Magento/Downloadable/Block/Customer/Products/ListProducts.php b/app/code/Magento/Downloadable/Block/Customer/Products/ListProducts.php
@@ -13,7 +13,7 @@
 /**
  * Block to display downloadable links bought by customer
  *
- * @author      Magento Core Team <core@magentocommerce.com>
+ * @api
  */
 class ListProducts extends \Magento\Framework\View\Element\Template
 {
diff --git a/app/code/Magento/Downloadable/Block/Sales/Order/Email/Items/Downloadable.php b/app/code/Magento/Downloadable/Block/Sales/Order/Email/Items/Downloadable.php
@@ -16,7 +16,7 @@
 /**
  * Downlaodable Sales Order Email items renderer
  *
- * @author     Magento Core Team <core@magentocommerce.com>
+ * @api
  */
 class Downloadable extends \Magento\Sales\Block\Order\Email\Items\DefaultItems
 {
diff --git a/app/code/Magento/Downloadable/Block/Sales/Order/Email/Items/Order/Downloadable.php b/app/code/Magento/Downloadable/Block/Sales/Order/Email/Items/Order/Downloadable.php
@@ -16,7 +16,7 @@
 /**
  * Downloadable Sales Order Email items renderer
  *
- * @author     Magento Core Team <core@magentocommerce.com>
+ * @api
  */
 class Downloadable extends \Magento\Sales\Block\Order\Email\Items\Order\DefaultOrder
 {
diff --git a/app/code/Magento/Downloadable/Block/Sales/Order/Item/Renderer/Downloadable.php b/app/code/Magento/Downloadable/Block/Sales/Order/Item/Renderer/Downloadable.php
@@ -14,6 +14,7 @@
 
 /**
  * Downloadable order item render block
+ * @api
  */
 class Downloadable extends \Magento\Sales\Block\Order\Item\Renderer\DefaultRenderer
 {
diff --git a/app/code/Magento/Downloadable/Helper/File.php b/app/code/Magento/Downloadable/Helper/File.php
@@ -10,7 +10,7 @@
 /**
  * Downloadable Products File Helper
  *
- * @author      Magento Core Team <core@magentocommerce.com>
+ * @api
  */
 class File extends \Magento\Framework\App\Helper\AbstractHelper
 {
diff --git a/app/code/Magento/Downloadable/Model/ComponentInterface.php b/app/code/Magento/Downloadable/Model/ComponentInterface.php
@@ -8,7 +8,7 @@
 /**
  * Downloadable component interface
  *
- * @author      Magento Core Team <core@magentocommerce.com>
+ * @api
  */
 interface ComponentInterface
 {
diff --git a/app/code/Magento/Downloadable/Model/DownloadableOption.php b/app/code/Magento/Downloadable/Model/DownloadableOption.php
@@ -10,6 +10,7 @@
 
 /**
  * @codeCoverageIgnore
+ * @api
  */
 class DownloadableOption extends AbstractExtensibleModel implements DownloadableOptionInterface
 {
diff --git a/app/code/Magento/Downloadable/Model/Link.php b/app/code/Magento/Downloadable/Model/Link.php
@@ -15,7 +15,7 @@
  * @method int getProductId()
  * @method Link setProductId(int $value)
  *
- * @author      Magento Core Team <core@magentocommerce.com>
+ * @api
  */
 class Link extends \Magento\Framework\Model\AbstractExtensibleModel implements ComponentInterface, LinkInterface
 {
diff --git a/app/code/Magento/Downloadable/Model/Link/Builder.php b/app/code/Magento/Downloadable/Model/Link/Builder.php
@@ -13,6 +13,7 @@
 
 /**
  * Class Builder
+ * @api
  */
 class Builder
 {
diff --git a/app/code/Magento/Downloadable/Model/Link/Purchased.php b/app/code/Magento/Downloadable/Model/Link/Purchased.php
@@ -29,7 +29,7 @@
  * @method string getLinkSectionTitle()
  * @method \Magento\Downloadable\Model\Link\Purchased setLinkSectionTitle(string $value)
  *
- * @author      Magento Core Team <core@magentocommerce.com>
+ * @api
  */
 class Purchased extends \Magento\Framework\Model\AbstractModel
 {
diff --git a/app/code/Magento/Downloadable/Model/Link/Purchased/Item.php b/app/code/Magento/Downloadable/Model/Link/Purchased/Item.php
@@ -43,7 +43,7 @@
  * @method string getUpdatedAt()
  * @method Item setUpdatedAt($value)
  *
- * @author      Magento Core Team <core@magentocommerce.com>
+ * @api
  */
 class Item extends \Magento\Framework\Model\AbstractModel
 {
diff --git a/app/code/Magento/Downloadable/Model/Product/Type.php b/app/code/Magento/Downloadable/Model/Product/Type.php
@@ -11,7 +11,7 @@
 /**
  * Downloadable product type model
  *
- * @author      Magento Core Team <core@magentocommerce.com>
+ * @api
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
 class Type extends \Magento\Catalog\Model\Product\Type\Virtual
diff --git a/app/code/Magento/Downloadable/Model/Product/TypeHandler/Link.php b/app/code/Magento/Downloadable/Model/Product/TypeHandler/Link.php
@@ -11,6 +11,7 @@
 
 /**
  * Class Link
+ * @api
  */
 class Link extends AbstractTypeHandler
 {
diff --git a/app/code/Magento/Downloadable/Model/Product/TypeHandler/Sample.php b/app/code/Magento/Downloadable/Model/Product/TypeHandler/Sample.php
@@ -11,6 +11,7 @@
 
 /**
  * Class Sample
+ * @api
  */
 class Sample extends AbstractTypeHandler
 {
diff --git a/app/code/Magento/Downloadable/Model/Product/TypeHandler/TypeHandlerInterface.php b/app/code/Magento/Downloadable/Model/Product/TypeHandler/TypeHandlerInterface.php
@@ -9,6 +9,7 @@
 
 /**
  * Interface TypeHandlerInterface
+ * @api
  */
 interface TypeHandlerInterface
 {
diff --git a/app/code/Magento/Downloadable/Model/ResourceModel/Link.php b/app/code/Magento/Downloadable/Model/ResourceModel/Link.php
@@ -12,7 +12,7 @@
 /**
  * Downloadable Product  Samples resource model
  *
- * @author      Magento Core Team <core@magentocommerce.com>
+ * @api
  */
 class Link extends \Magento\Framework\Model\ResourceModel\Db\AbstractDb
 {
diff --git a/app/code/Magento/Downloadable/Model/ResourceModel/Link/Purchased/Collection.php b/app/code/Magento/Downloadable/Model/ResourceModel/Link/Purchased/Collection.php
@@ -8,7 +8,7 @@
 /**
  * Downloadable links purchased resource collection
  *
- * @author      Magento Core Team <core@magentocommerce.com>
+ * @api
  */
 class Collection extends \Magento\Framework\Model\ResourceModel\Db\Collection\AbstractCollection
 {
diff --git a/app/code/Magento/Downloadable/Model/ResourceModel/Link/Purchased/Item/Collection.php b/app/code/Magento/Downloadable/Model/ResourceModel/Link/Purchased/Item/Collection.php
@@ -8,7 +8,7 @@
 /**
  * Downloadable links purchased items resource collection
  *
- * @author      Magento Core Team <core@magentocommerce.com>
+ * @api
  */
 class Collection extends \Magento\Framework\Model\ResourceModel\Db\Collection\AbstractCollection
 {
diff --git a/app/code/Magento/Downloadable/Model/ResourceModel/Sample.php b/app/code/Magento/Downloadable/Model/ResourceModel/Sample.php
@@ -10,7 +10,7 @@
 /**
  * Downloadable Product  Samples resource model
  *
- * @author      Magento Core Team <core@magentocommerce.com>
+ * @api
  */
 class Sample extends \Magento\Framework\Model\ResourceModel\Db\AbstractDb
 {
diff --git a/app/code/Magento/Downloadable/Model/ResourceModel/Sample/Collection.php b/app/code/Magento/Downloadable/Model/ResourceModel/Sample/Collection.php
@@ -10,7 +10,7 @@
 /**
  * Downloadable samples resource collection
  *
- * @author      Magento Core Team <core@magentocommerce.com>
+ * @api
  */
 class Collection extends \Magento\Framework\Model\ResourceModel\Db\Collection\AbstractCollection
 {
diff --git a/app/code/Magento/Downloadable/Model/Sales/Order/Pdf/Items/Creditmemo.php b/app/code/Magento/Downloadable/Model/Sales/Order/Pdf/Items/Creditmemo.php
@@ -7,6 +7,7 @@
 
 /**
  * Order Creditmemo Downloadable Pdf Items renderer
+ * @api
  */
 class Creditmemo extends \Magento\Downloadable\Model\Sales\Order\Pdf\Items\AbstractItems
 {
diff --git a/app/code/Magento/Downloadable/Model/Sales/Order/Pdf/Items/Invoice.php b/app/code/Magento/Downloadable/Model/Sales/Order/Pdf/Items/Invoice.php
@@ -7,6 +7,7 @@
 
 /**
  * Order Invoice Downloadable Pdf Items renderer
+ * @api
  */
 class Invoice extends \Magento\Downloadable\Model\Sales\Order\Pdf\Items\AbstractItems
 {
diff --git a/app/code/Magento/Downloadable/Model/Sample.php b/app/code/Magento/Downloadable/Model/Sample.php
@@ -14,7 +14,7 @@
  * @method \Magento\Downloadable\Model\ResourceModel\Sample getResource()
  * @method int getProductId()
  *
- * @author      Magento Core Team <core@magentocommerce.com>
+ * @api
  */
 class Sample extends \Magento\Framework\Model\AbstractExtensibleModel implements ComponentInterface, SampleInterface
 {
diff --git a/app/code/Magento/Downloadable/Model/Sample/Builder.php b/app/code/Magento/Downloadable/Model/Sample/Builder.php
@@ -15,6 +15,7 @@
 
 /**
  * Class Builder
+ * @api
  */
 class Builder
 {
diff --git a/app/code/Magento/Downloadable/view/frontend/web/downloadable.js b/app/code/Magento/Downloadable/view/frontend/web/downloadable.js
@@ -2,7 +2,9 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
-
+/**
+ * @api
+ */
 define([
     'jquery',
     'jquery/ui',

Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@`
`12`	`12`
`13`	`13`	`/**`
`14`	`14`	`* Downloadable Product Links part block`
	`15`	`+ * @api`
`15`	`16`	`*/`
`16`	`17`	`class Links extends \Magento\Catalog\Block\Product\AbstractProduct`
`17`	`18`	`{`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@`
`13`	`13`	`/**`
`14`	`14`	`* Downloadable Product Samples part block`
`15`	`15`	`*`
`16`		`- * @author Magento Core Team <[email protected]>`
	`16`	`+ * @api`
`17`	`17`	`*/`
`18`	`18`	`class Samples extends \Magento\Catalog\Block\Product\AbstractProduct`
`19`	`19`	`{`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,9 @@`
`11`	`11`	`*/`
`12`	`12`	`namespace Magento\Downloadable\Block\Catalog\Product\View;`
`13`	`13`
	`14`	`+/**`
	`15`	`+ * @api`
	`16`	`+ */`
`14`	`17`	`class Type extends \Magento\Catalog\Block\Product\View\Type\Virtual`
`15`	`18`	`{`
`16`	`19`	`}`
Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,9 @@`
`14`	`14`	`use Magento\Framework\Pricing\PriceCurrencyInterface;`
`15`	`15`	`use Magento\Framework\View\Element\Message\InterpretationStrategyInterface;`
`16`	`16`
	`17`	`+/**`
	`18`	`+ * @api`
	`19`	`+ */`
`17`	`20`	`class Renderer extends \Magento\Checkout\Block\Cart\Item\Renderer`
`18`	`21`	`{`
`19`	`22`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,9 @@`
`13`	`13`
`14`	`14`	`use Magento\Framework\View\Element\Template;`
`15`	`15`
	`16`	`+/**`
	`17`	`+ * @api`
	`18`	`+ */`
`16`	`19`	`class Success extends \Magento\Checkout\Block\Onepage\Success`
`17`	`20`	`{`
`18`	`21`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@`
`16`	`16`	`/**`
`17`	`17`	`* Downlaodable Sales Order Email items renderer`
`18`	`18`	`*`
`19`		`- * @author Magento Core Team <[email protected]>`
	`19`	`+ * @api`
`20`	`20`	`*/`
`21`	`21`	`class Downloadable extends \Magento\Sales\Block\Order\Email\Items\DefaultItems`
`22`	`22`	`{`
Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,7 @@`
`14`	`14`
`15`	`15`	`/**`
`16`	`16`	`* Downloadable order item render block`
	`17`	`+ * @api`
`17`	`18`	`*/`
`18`	`19`	`class Downloadable extends \Magento\Sales\Block\Order\Item\Renderer\DefaultRenderer`
`19`	`20`	`{`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@`
`10`	`10`	`/**`
`11`	`11`	`* Downloadable Products File Helper`
`12`	`12`	`*`
`13`		`- * @author Magento Core Team <[email protected]>`
	`13`	`+ * @api`
`14`	`14`	`*/`
`15`	`15`	`class File extends \Magento\Framework\App\Helper\AbstractHelper`
`16`	`16`	`{`