Marked classes and interfaces as API

ProkopovVitaliy · Gabriel Galvao da Gama · commit c1bc7a93efce · 2021-06-11T12:30:13.000+01:00
diff --git a/app/code/Magento/Customer/Controller/RegistryConstants.php b/app/code/Magento/Customer/Controller/RegistryConstants.php
@@ -8,6 +8,7 @@
 /**
  * Declarations of core registry keys used by the Customer module
  *
+ * @api
  */
 class RegistryConstants
 {
diff --git a/app/code/Magento/Customer/Model/Context.php b/app/code/Magento/Customer/Model/Context.php
@@ -5,6 +5,11 @@
  */
 namespace Magento\Customer\Model;
 
+/**
+ * Class Context
+ *
+ * @api
+ */
 class Context
 {
     /**
diff --git a/app/code/Magento/Sales/Model/ResourceModel/Order/Collection/Factory.php b/app/code/Magento/Sales/Model/ResourceModel/Order/Collection/Factory.php
@@ -6,6 +6,8 @@
 namespace Magento\Sales\Model\ResourceModel\Order\Collection;
 
 /**
+ * Class Factory
+ *
  * @api
  */
 class Factory
diff --git a/app/code/Magento/Shipping/Model/Carrier/CarrierInterface.php b/app/code/Magento/Shipping/Model/Carrier/CarrierInterface.php
@@ -8,6 +8,7 @@
 /**
  * Interface \Magento\Shipping\Model\Carrier\CarrierInterface
  *
+ * @api
  */
 interface CarrierInterface
 {
diff --git a/app/code/Magento/Widget/Block/BlockInterface.php b/app/code/Magento/Widget/Block/BlockInterface.php
@@ -8,6 +8,7 @@
  * Widget Block Interface
  *
  * @author      Magento Core Team <core@magentocommerce.com>
+ * @api
  */
 namespace Magento\Widget\Block;
 
diff --git a/lib/internal/Magento/Framework/Api/AbstractSimpleObject.php b/lib/internal/Magento/Framework/Api/AbstractSimpleObject.php
@@ -8,6 +8,8 @@
 /**
  * Base Class for simple data Objects
  * @SuppressWarnings(PHPMD.NumberOfChildren)
+ *
+ * @api
  */
 abstract class AbstractSimpleObject
 {
diff --git a/lib/internal/Magento/Framework/App/Action/HttpGetActionInterface.php b/lib/internal/Magento/Framework/App/Action/HttpGetActionInterface.php
@@ -8,12 +8,14 @@
 
 namespace Magento\Framework\App\Action;
 
+use Magento\Framework\App\ActionInterface;
+
 /**
  * Marker for actions processing GET requests.
  *
  * @api
  */
-interface HttpGetActionInterface extends HttpHeadActionInterface
+interface HttpGetActionInterface extends ActionInterface
 {
 
 }
diff --git a/lib/internal/Magento/Framework/App/Filesystem/DirectoryList.php b/lib/internal/Magento/Framework/App/Filesystem/DirectoryList.php
@@ -9,6 +9,8 @@
 
 /**
  * A Magento application specific list of directories
+ *
+ * @api
  */
 class DirectoryList extends \Magento\Framework\Filesystem\DirectoryList
 {
diff --git a/lib/internal/Magento/Framework/App/Http/Context.php b/lib/internal/Magento/Framework/App/Http/Context.php
@@ -10,6 +10,8 @@
 
 /**
  * Context data for requests
+ *
+ * @api
  */
 class Context
 {
diff --git a/lib/internal/Magento/Framework/App/Response/Http/FileFactory.php b/lib/internal/Magento/Framework/App/Response/Http/FileFactory.php
@@ -11,6 +11,8 @@
 
 /**
  * Class FileFactory serves to declare file content in response for download.
+ *
+ * @api
  */
 class FileFactory
 {
diff --git a/lib/internal/Magento/Framework/Controller/Result/Raw.php b/lib/internal/Magento/Framework/Controller/Result/Raw.php
@@ -12,6 +12,8 @@
 /**
  * A result that contains raw response - may be good for passing through files,
  * returning result of downloads or some other binary contents
+ *
+ * @api
  */
 class Raw extends AbstractResult
 {
diff --git a/lib/internal/Magento/Framework/Filesystem/DirectoryList.php b/lib/internal/Magento/Framework/Filesystem/DirectoryList.php
@@ -21,6 +21,8 @@
  * This object is intended to be immutable (a "value object").
  * The defaults are pre-defined and can be modified only by inheritors of this class.
  * Through the constructor, it is possible to inject custom paths or URL paths, but impossible to inject new types.
+ *
+ * @api
  */
 class DirectoryList
 {
diff --git a/lib/internal/Magento/Framework/Logger/Handler/Base.php b/lib/internal/Magento/Framework/Logger/Handler/Base.php
@@ -13,6 +13,8 @@
 
 /**
  * Base stream handler
+ *
+ * @api
  */
 class Base extends StreamHandler
 {
diff --git a/lib/internal/Magento/Framework/View/Element/Html/Select.php b/lib/internal/Magento/Framework/View/Element/Html/Select.php
@@ -7,6 +7,8 @@
 
 /**
  * HTML select element block
+ *
+ * @api
  */
 class Select extends \Magento\Framework\View\Element\AbstractBlock
 {
diff --git a/lib/internal/Magento/Framework/View/Element/UiComponent/DataProvider/DataProvider.php b/lib/internal/Magento/Framework/View/Element/UiComponent/DataProvider/DataProvider.php
@@ -14,6 +14,8 @@
 
 /**
  * Class DataProvider
+ *
+ * @api
  */
 class DataProvider implements DataProviderInterface
 {
diff --git a/lib/internal/Magento/Framework/View/Element/UiComponent/DataProvider/SearchResult.php b/lib/internal/Magento/Framework/View/Element/UiComponent/DataProvider/SearchResult.php
@@ -19,6 +19,7 @@
  * Class SearchResult
  * Generic Search Result
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
+ * @api
  */
 class SearchResult extends AbstractCollection implements Api\Search\SearchResultInterface
 {
diff --git a/lib/internal/Magento/Framework/View/LayoutFactory.php b/lib/internal/Magento/Framework/View/LayoutFactory.php
@@ -7,6 +7,8 @@
 
 /**
  * Factory class for Layout
+ *
+ * @api
  */
 class LayoutFactory
 {

Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,7 @@`
`8`	`8`	`/**`
`9`	`9`	`* Declarations of core registry keys used by the Customer module`
`10`	`10`	`*`
	`11`	`+ * @api`
`11`	`12`	`*/`
`12`	`13`	`class RegistryConstants`
`13`	`14`	`{`
Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,7 @@`
`8`	`8`	`/**`
`9`	`9`	`* Interface \Magento\Shipping\Model\Carrier\CarrierInterface`
`10`	`10`	`*`
	`11`	`+ * @api`
`11`	`12`	`*/`
`12`	`13`	`interface CarrierInterface`
`13`	`14`	`{`
Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,7 @@`
`8`	`8`	`* Widget Block Interface`
`9`	`9`	`*`
`10`	`10`	`* @author Magento Core Team <core@magentocommerce.com>`
	`11`	`+ * @api`
`11`	`12`	`*/`
`12`	`13`	`namespace Magento\Widget\Block;`
`13`	`14`
Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,8 @@`
`8`	`8`	`/**`
`9`	`9`	`* Base Class for simple data Objects`
`10`	`10`	`* @SuppressWarnings(PHPMD.NumberOfChildren)`
	`11`	`+ *`
	`12`	`+ * @api`
`11`	`13`	`*/`
`12`	`14`	`abstract class AbstractSimpleObject`
`13`	`15`	`{`
Original file line number	Diff line number	Diff line change
`@@ -8,12 +8,14 @@`
`8`	`8`
`9`	`9`	`namespace Magento\Framework\App\Action;`
`10`	`10`
	`11`	`+use Magento\Framework\App\ActionInterface;`
	`12`	`+`
`11`	`13`	`/**`
`12`	`14`	`* Marker for actions processing GET requests.`
`13`	`15`	`*`
`14`	`16`	`* @api`
`15`	`17`	`*/`
`16`		`-interface HttpGetActionInterface extends HttpHeadActionInterface`
	`18`	`+interface HttpGetActionInterface extends ActionInterface`
`17`	`19`	`{`
`18`	`20`
`19`	`21`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,8 @@`
`9`	`9`
`10`	`10`	`/**`
`11`	`11`	`* A Magento application specific list of directories`
	`12`	`+ *`
	`13`	`+ * @api`
`12`	`14`	`*/`
`13`	`15`	`class DirectoryList extends \Magento\Framework\Filesystem\DirectoryList`
`14`	`16`	`{`
Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,8 @@`
`10`	`10`
`11`	`11`	`/**`
`12`	`12`	`* Context data for requests`
	`13`	`+ *`
	`14`	`+ * @api`
`13`	`15`	`*/`
`14`	`16`	`class Context`
`15`	`17`	`{`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,8 @@`
`11`	`11`
`12`	`12`	`/**`
`13`	`13`	`* Class FileFactory serves to declare file content in response for download.`
	`14`	`+ *`
	`15`	`+ * @api`
`14`	`16`	`*/`
`15`	`17`	`class FileFactory`
`16`	`18`	`{`