Mark Various Modules interfaces as API

magento · Feb 13, 2021 · acf688a · acf688a
1 parent 517a568
commit acf688a
Show file tree

Hide file tree

Showing 29 changed files with 55 additions and 7 deletions.
diff --git a/app/code/Magento/Search/Model/SearchEngine/ValidatorInterface.php b/app/code/Magento/Search/Model/SearchEngine/ValidatorInterface.php
@@ -9,6 +9,8 @@
 
 /**
  * Validate search engine configuration
+ *
+ * @api
  */
 interface ValidatorInterface
 {

diff --git a/app/code/Magento/Search/Setup/InstallConfigInterface.php b/app/code/Magento/Search/Setup/InstallConfigInterface.php
@@ -9,6 +9,8 @@
 
 /**
  * Configure search engine from installation input
+ *
+ * @api
  */
 interface InstallConfigInterface
 {

diff --git a/app/code/Magento/Security/Api/Data/UserExpirationInterface.php b/app/code/Magento/Security/Api/Data/UserExpirationInterface.php
@@ -3,7 +3,6 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
-
 declare(strict_types=1);
 
 namespace Magento\Security\Api\Data;
@@ -12,6 +11,8 @@
 
 /**
  * Interface UserExpirationInterface to be used as a DTO for expires_at property on User model.
+ *
+ * @api
  */
 interface UserExpirationInterface extends \Magento\Framework\Api\ExtensibleDataInterface
 {

diff --git a/app/code/Magento/Shipping/Model/Carrier/Source/GenericInterface.php b/app/code/Magento/Shipping/Model/Carrier/Source/GenericInterface.php
@@ -9,6 +9,8 @@
 
 /**
  * Interface GenericInterface
+ *
+ * @api
  */
 interface GenericInterface extends OptionSourceInterface
 {

diff --git a/app/code/Magento/Store/Model/Config/Importer/Processor/ProcessorInterface.php b/app/code/Magento/Store/Model/Config/Importer/Processor/ProcessorInterface.php
@@ -9,6 +9,8 @@
 
 /**
  * The processor for store manipulations.
+ *
+ * @api
  */
 interface ProcessorInterface
 {

diff --git a/app/code/Magento/Store/Model/StoreResolver/ReaderInterface.php b/app/code/Magento/Store/Model/StoreResolver/ReaderInterface.php
@@ -8,6 +8,7 @@
 /**
  * Interface \Magento\Store\Model\StoreResolver\ReaderInterface
  *
+ * @api
  */
 interface ReaderInterface
 {

diff --git a/app/code/Magento/Store/Model/StoreSwitcher/ContextInterface.php b/app/code/Magento/Store/Model/StoreSwitcher/ContextInterface.php
@@ -11,6 +11,8 @@
 
 /**
  * Store switcher context interface
+ *
+ * @api
  */
 interface ContextInterface
 {

diff --git a/app/code/Magento/Store/Model/StoreSwitcher/RedirectDataInterface.php b/app/code/Magento/Store/Model/StoreSwitcher/RedirectDataInterface.php
@@ -9,6 +9,8 @@
 
 /**
  * Store switcher redirect data interface
+ *
+ * @api
  */
 interface RedirectDataInterface
 {

diff --git a/app/code/Magento/Store/Model/StoreSwitcher/RedirectDataPostprocessorInterface.php b/app/code/Magento/Store/Model/StoreSwitcher/RedirectDataPostprocessorInterface.php
@@ -9,6 +9,8 @@
 
 /**
  * Store switcher redirect data post-processor interface
+ *
+ * @api
  */
 interface RedirectDataPostprocessorInterface
 {

diff --git a/app/code/Magento/Store/Model/StoreSwitcher/RedirectDataPreprocessorInterface.php b/app/code/Magento/Store/Model/StoreSwitcher/RedirectDataPreprocessorInterface.php
@@ -9,6 +9,8 @@
 
 /**
  * Store switcher redirect data pre-processor interface
+ *
+ * @api
  */
 interface RedirectDataPreprocessorInterface
 {

diff --git a/app/code/Magento/Store/Model/StoreSwitcher/RedirectDataSerializerInterface.php b/app/code/Magento/Store/Model/StoreSwitcher/RedirectDataSerializerInterface.php
@@ -9,6 +9,8 @@
 
 /**
  * Store switcher redirect data serializer interface
+ *
+ * @api
  */
 interface RedirectDataSerializerInterface
 {

diff --git a/app/code/Magento/Store/Model/StoreSwitcherInterface.php b/app/code/Magento/Store/Model/StoreSwitcherInterface.php
@@ -12,6 +12,8 @@
 
 /**
  * Handles store switching procedure and detects url for final redirect after store switching.
+ *
+ * @api
  */
 interface StoreSwitcherInterface
 {

diff --git a/app/code/Magento/Tax/Api/TaxAddressManagerInterface.php b/app/code/Magento/Tax/Api/TaxAddressManagerInterface.php
@@ -3,13 +3,14 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
-
 namespace Magento\Tax\Api;
 
 use Magento\Customer\Model\Address;
 
 /**
  * Interface to save data in customer session.
+ *
+ * @api
  */
 interface TaxAddressManagerInterface
 {

diff --git a/app/code/Magento/Tax/Model/System/Message/NotificationInterface.php b/app/code/Magento/Tax/Model/System/Message/NotificationInterface.php
@@ -7,6 +7,8 @@
 
 /**
  * Notification interface for tax-related configuration issues.
+ *
+ * @api
  */
 interface NotificationInterface extends \Magento\Framework\Notification\MessageInterface
 {

diff --git a/app/code/Magento/Tax/Model/TaxClass/Type/TypeInterface.php b/app/code/Magento/Tax/Model/TaxClass/Type/TypeInterface.php
@@ -3,15 +3,12 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
-
-/**
- * Interface for tax classes
- */
 namespace Magento\Tax\Model\TaxClass\Type;
 
 /**
  * Interface \Magento\Tax\Model\TaxClass\Type\TypeInterface
  *
+ * @api
  */
 interface TypeInterface
 {

diff --git a/app/code/Magento/Theme/Model/Design/Config/MetadataProviderInterface.php b/app/code/Magento/Theme/Model/Design/Config/MetadataProviderInterface.php
@@ -8,6 +8,7 @@
 /**
  * Interface \Magento\Theme\Model\Design\Config\MetadataProviderInterface
  *
+ * @api
  */
 interface MetadataProviderInterface
 {

diff --git a/app/code/Magento/Theme/Model/Theme/StoreThemesResolverInterface.php b/app/code/Magento/Theme/Model/Theme/StoreThemesResolverInterface.php
@@ -11,6 +11,8 @@
 
 /**
  * Store associated themes resolver.
+ *
+ * @api
  */
 interface StoreThemesResolverInterface
 {

diff --git a/app/code/Magento/Ui/Component/Form/Element/DataType/DataTypeInterface.php b/app/code/Magento/Ui/Component/Form/Element/DataType/DataTypeInterface.php
@@ -9,6 +9,8 @@
 
 /**
  * Interface DataTypeInterface
+ *
+ * @api
  */
 interface DataTypeInterface extends UiComponentInterface
 {

diff --git a/app/code/Magento/Ui/Component/Layout/Tabs/TabInterface.php b/app/code/Magento/Ui/Component/Layout/Tabs/TabInterface.php
@@ -7,6 +7,8 @@
 
 /**
  * Interface TabInterface
+ *
+ * @api
  */
 interface TabInterface
 {

diff --git a/app/code/Magento/Ui/Component/Wysiwyg/ConfigInterface.php b/app/code/Magento/Ui/Component/Wysiwyg/ConfigInterface.php
@@ -7,6 +7,8 @@
 
 /**
  * Interface ConfigInterface
+ *
+ * @api
  */
 interface ConfigInterface
 {

diff --git a/app/code/Magento/Ui/Config/Argument/ParserInterface.php b/app/code/Magento/Ui/Config/Argument/ParserInterface.php
@@ -7,6 +7,8 @@
 
 /**
  * Convert node to array
+ *
+ * @api
  */
 interface ParserInterface
 {

diff --git a/app/code/Magento/Ui/Config/ConverterInterface.php b/app/code/Magento/Ui/Config/ConverterInterface.php
@@ -7,6 +7,8 @@
 
 /**
  * Converter interface is used to convert UI Component XML configuration into UI Component interfaces arguments
+ *
+ * @api
  */
 interface ConverterInterface
 {

diff --git a/app/code/Magento/Ui/Controller/UiActionInterface.php b/app/code/Magento/Ui/Controller/UiActionInterface.php
@@ -7,6 +7,8 @@
 
 /**
  * Interface UiActionInterface
+ *
+ * @api
  */
 interface UiActionInterface
 {

diff --git a/app/code/Magento/Ui/DataProvider/AddFieldToCollectionInterface.php b/app/code/Magento/Ui/DataProvider/AddFieldToCollectionInterface.php
@@ -9,6 +9,8 @@
 
 /**
  * AddFieldToCollection interface
+ *
+ * @api
  */
 interface AddFieldToCollectionInterface
 {

diff --git a/app/code/Magento/Ui/DataProvider/AddFilterToCollectionInterface.php b/app/code/Magento/Ui/DataProvider/AddFilterToCollectionInterface.php
@@ -9,6 +9,8 @@
 
 /**
  * AddFilterToCollection interface
+ *
+ * @api
  */
 interface AddFilterToCollectionInterface
 {

diff --git a/app/code/Magento/Ui/DataProvider/Mapper/MapperInterface.php b/app/code/Magento/Ui/DataProvider/Mapper/MapperInterface.php
@@ -7,6 +7,8 @@
 
 /**
  * Interface MapperInterface
+ *
+ * @api
  */
 interface MapperInterface
 {

diff --git a/app/code/Magento/Ui/DataProvider/Modifier/PoolInterface.php b/app/code/Magento/Ui/DataProvider/Modifier/PoolInterface.php
@@ -8,6 +8,7 @@
 /**
  * Interface \Magento\Ui\DataProvider\Modifier\PoolInterface
  *
+ * @api
  */
 interface PoolInterface
 {

diff --git a/app/code/Magento/Ui/Model/ColorPicker/ModeInterface.php b/app/code/Magento/Ui/Model/ColorPicker/ModeInterface.php
@@ -10,6 +10,8 @@
 
 /**
  * Mode interface for color modes
+ *
+ * @api
  */
 interface ModeInterface
 {
@@ -18,5 +20,5 @@ interface ModeInterface
      *
      * @return array
      */
-    public function getConfig() : array ;
+    public function getConfig(): array ;
 }
diff --git a/app/code/Magento/Ui/Model/UrlInput/ConfigInterface.php b/app/code/Magento/Ui/Model/UrlInput/ConfigInterface.php
@@ -9,6 +9,8 @@
 
 /**
  * Config interface for url link types
+ *
+ * @api
  */
 interface ConfigInterface
 {
-Original file line number
+Diff line change
@@ Expand Up / @@ -9,6 +9,8 @@ @@
     /**
      * Validate search engine configuration
+     *
+     * @api
      */
     interface ValidatorInterface
     {
@@ Expand Down @@