Mark Framework interfaces as API part 7

update
magento · Apr 3, 2021 · 7e9365b · 7e9365b
1 parent be82efb
commit 7e9365b
Show file tree

Hide file tree

Showing 27 changed files with 53 additions and 5 deletions.
diff --git a/...ernal/Magento/Framework/Stdlib/DateTime/Timezone/LocalizedDateToUtcConverterInterface.php b/...ernal/Magento/Framework/Stdlib/DateTime/Timezone/LocalizedDateToUtcConverterInterface.php
@@ -9,6 +9,8 @@
 
 /*
  * Interface for converting localized date to UTC
+ *
+ * @api
  */
 interface LocalizedDateToUtcConverterInterface
 {

diff --git a/lib/internal/Magento/Framework/TestFramework/Unit/Autoloader/GeneratorInterface.php b/lib/internal/Magento/Framework/TestFramework/Unit/Autoloader/GeneratorInterface.php
@@ -8,6 +8,8 @@
 
 /**
  * Interface for generation of a class of specific type
+ *
+ * @api
  */
 interface GeneratorInterface
 {

diff --git a/lib/internal/Magento/Framework/Translate/Inline/ProviderInterface.php b/lib/internal/Magento/Framework/Translate/Inline/ProviderInterface.php
@@ -8,6 +8,8 @@
 
 /**
  * Factory like class to return an instance of the inline translate.
+ *
+ * @api
  */
 interface ProviderInterface
 {

diff --git a/lib/internal/Magento/Framework/TranslateInterface.php b/lib/internal/Magento/Framework/TranslateInterface.php
@@ -7,6 +7,8 @@
 
 /**
  * @todo change this interface when i18n-related logic is moved to library
+ *
+ * @api
  */
 interface TranslateInterface
 {

diff --git a/lib/internal/Magento/Framework/Url/ModifierInterface.php b/lib/internal/Magento/Framework/Url/ModifierInterface.php
@@ -7,6 +7,8 @@
 
 /**
  * URL modifier interface.
+ *
+ * @api
  */
 interface ModifierInterface
 {

diff --git a/lib/internal/Magento/Framework/Url/RouteParamsPreprocessorInterface.php b/lib/internal/Magento/Framework/Url/RouteParamsPreprocessorInterface.php
@@ -7,6 +7,8 @@
 
 /**
  * Route parameters preprocessor interface.
+ *
+ * @api
  */
 interface RouteParamsPreprocessorInterface
 {

diff --git a/lib/internal/Magento/Framework/Validator/Constraint/OptionInterface.php b/lib/internal/Magento/Framework/Validator/Constraint/OptionInterface.php
@@ -10,6 +10,7 @@
 /**
  * Interface \Magento\Framework\Validator\Constraint\OptionInterface
  *
+ * @api
  */
 interface OptionInterface
 {

diff --git a/lib/internal/Magento/Framework/Validator/HTML/AttributeValidatorInterface.php b/lib/internal/Magento/Framework/Validator/HTML/AttributeValidatorInterface.php
@@ -3,7 +3,6 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
-
 declare(strict_types=1);
 
 namespace Magento\Framework\Validator\HTML;
@@ -12,6 +11,8 @@
 
 /**
  * Validates HTML attributes content.
+ *
+ * @api
  */
 interface AttributeValidatorInterface
 {

diff --git a/lib/internal/Magento/Framework/Validator/HTML/TagValidatorInterface.php b/lib/internal/Magento/Framework/Validator/HTML/TagValidatorInterface.php
@@ -3,7 +3,6 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
-
 declare(strict_types=1);
 
 namespace Magento\Framework\Validator\HTML;
@@ -12,6 +11,8 @@
 
 /**
  * Validates tag for user HTML content.
+ *
+ * @api
  */
 interface TagValidatorInterface
 {

diff --git a/lib/internal/Magento/Framework/Validator/HTML/WYSIWYGValidatorInterface.php b/lib/internal/Magento/Framework/Validator/HTML/WYSIWYGValidatorInterface.php
@@ -3,7 +3,6 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
-
 declare(strict_types=1);
 
 namespace Magento\Framework\Validator\HTML;
@@ -12,6 +11,8 @@
 
 /**
  * Validates user HTML.
+ *
+ * @api
  */
 interface WYSIWYGValidatorInterface
 {

diff --git a/lib/internal/Magento/Framework/View/Asset/ContentProcessorInterface.php b/lib/internal/Magento/Framework/View/Asset/ContentProcessorInterface.php
@@ -9,6 +9,8 @@
 
 /**
  * Interface ContentProcessorInterface
+ *
+ * @api
  */
 interface ContentProcessorInterface
 {

diff --git a/lib/internal/Magento/Framework/View/Asset/ContextInterface.php b/lib/internal/Magento/Framework/View/Asset/ContextInterface.php
@@ -3,11 +3,12 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
-
 namespace Magento\Framework\View\Asset;
 
 /**
  * An abstraction for getting context path of an asset
+ *
+ * @api
  */
 interface ContextInterface
 {

diff --git a/lib/internal/Magento/Framework/View/Asset/LockerProcessInterface.php b/lib/internal/Magento/Framework/View/Asset/LockerProcessInterface.php
@@ -7,6 +7,8 @@
 
 /**
  * Interface LockerProcessInterface
+ *
+ * @api
  */
 interface LockerProcessInterface
 {

diff --git a/lib/internal/Magento/Framework/View/Asset/MergeStrategyInterface.php b/lib/internal/Magento/Framework/View/Asset/MergeStrategyInterface.php
@@ -7,6 +7,8 @@
 
 /**
  * Interface for merging multiple assets into one
+ *
+ * @api
  */
 interface MergeStrategyInterface
 {

diff --git a/lib/internal/Magento/Framework/View/Asset/MergeableInterface.php b/lib/internal/Magento/Framework/View/Asset/MergeableInterface.php
@@ -7,6 +7,8 @@
 
 /**
  * Interface of an asset that can be merged with other assets
+ *
+ * @api
  */
 interface MergeableInterface extends LocalInterface
 {

diff --git a/lib/internal/Magento/Framework/View/Asset/PreProcessor/FilenameResolverInterface.php b/lib/internal/Magento/Framework/View/Asset/PreProcessor/FilenameResolverInterface.php
@@ -7,6 +7,8 @@
 
 /**
  * Interface FilenameResolverInterface
+ *
+ * @api
  */
 interface FilenameResolverInterface
 {

diff --git a/lib/internal/Magento/Framework/View/Design/Fallback/Rule/RuleInterface.php b/lib/internal/Magento/Framework/View/Design/Fallback/Rule/RuleInterface.php
@@ -9,6 +9,8 @@
  * Rule Interface
  *
  * Interface for search path resolution during fallback process
+ *
+ * @api
  */
 interface RuleInterface
 {

diff --git a/lib/internal/Magento/Framework/View/Design/FileResolution/Fallback/ResolverInterface.php b/lib/internal/Magento/Framework/View/Design/FileResolution/Fallback/ResolverInterface.php
@@ -3,14 +3,15 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
-
 namespace Magento\Framework\View\Design\FileResolution\Fallback;
 
 use Magento\Framework\View\Design\FileResolution\Fallback;
 use Magento\Framework\View\Design\ThemeInterface;
 
 /**
  * Interface for resolvers of view files using fallback rules
+ *
+ * @api
  */
 interface ResolverInterface
 {

diff --git a/lib/internal/Magento/Framework/View/Design/Theme/Customization/ConfigInterface.php b/lib/internal/Magento/Framework/View/Design/Theme/Customization/ConfigInterface.php
@@ -7,6 +7,8 @@
 
 /**
  * Theme customization configuration interface
+ *
+ * @api
  */
 interface ConfigInterface
 {

diff --git a/lib/internal/Magento/Framework/View/Design/Theme/Customization/FileAssetInterface.php b/lib/internal/Magento/Framework/View/Design/Theme/Customization/FileAssetInterface.php
@@ -7,6 +7,8 @@
 
 /**
  * Theme asset file interface
+ *
+ * @api
  */
 interface FileAssetInterface
 {

diff --git a/lib/internal/Magento/Framework/View/Design/Theme/Customization/FileInterface.php b/lib/internal/Magento/Framework/View/Design/Theme/Customization/FileInterface.php
@@ -7,6 +7,8 @@
 
 /**
  * Theme service file interface
+ *
+ * @api
  */
 interface FileInterface
 {

diff --git a/lib/internal/Magento/Framework/View/Design/Theme/CustomizationInterface.php b/lib/internal/Magento/Framework/View/Design/Theme/CustomizationInterface.php
@@ -7,6 +7,8 @@
 
 /**
  * Theme customization interface
+ *
+ * @api
  */
 interface CustomizationInterface
 {

diff --git a/lib/internal/Magento/Framework/View/Design/Theme/File/CollectionInterface.php b/lib/internal/Magento/Framework/View/Design/Theme/File/CollectionInterface.php
@@ -7,6 +7,8 @@
 
 /**
  * Design Theme File collection interface
+ *
+ * @api
  */
 interface CollectionInterface
 {

diff --git a/lib/internal/Magento/Framework/View/Design/Theme/FileInterface.php b/lib/internal/Magento/Framework/View/Design/Theme/FileInterface.php
@@ -7,6 +7,8 @@
 
 /**
  * Theme file interface
+ *
+ * @api
  */
 interface FileInterface
 {

diff --git a/lib/internal/Magento/Framework/View/Design/Theme/Image/PathInterface.php b/lib/internal/Magento/Framework/View/Design/Theme/Image/PathInterface.php
@@ -9,6 +9,8 @@
 
 /**
  * Theme Image Path interface
+ *
+ * @api
  */
 interface PathInterface
 {

diff --git a/lib/internal/Magento/Framework/View/Design/Theme/ResolverInterface.php b/lib/internal/Magento/Framework/View/Design/Theme/ResolverInterface.php
@@ -7,6 +7,8 @@
 
 /**
  * Theme resolver interface
+ *
+ * @api
  */
 interface ResolverInterface
 {

diff --git a/lib/internal/Magento/Framework/View/Design/Theme/ThemeProviderInterface.php b/lib/internal/Magento/Framework/View/Design/Theme/ThemeProviderInterface.php
@@ -7,6 +7,8 @@
 
 /**
  * Interface ThemeProviderInterface
+ *
+ * @api
  */
 interface ThemeProviderInterface
 {
-Original file line number
+Diff line change
@@ Expand Up / @@ -9,6 +9,8 @@ @@
     /*
      * Interface for converting localized date to UTC
+     *
+     * @api
      */
     interface LocalizedDateToUtcConverterInterface
     {
@@ Expand Down @@