Mark Framework interfaces as API part 9

mrtuvn · mrtuvn · commit 81ec7c910e09 · 2021-04-03T08:37:35.000+07:00
update


update


up
diff --git a/lib/internal/Magento/Framework/View/File/FileList/CollateInterface.php b/lib/internal/Magento/Framework/View/File/FileList/CollateInterface.php
@@ -3,11 +3,14 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
 
 namespace Magento\Framework\View\File\FileList;
 
 /**
  * View file list collate interface
+ *
+ * @api
  */
 interface CollateInterface
 {
diff --git a/lib/internal/Magento/Framework/View/Helper/SecureHtmlRender/EventHandlerData.php b/lib/internal/Magento/Framework/View/Helper/SecureHtmlRender/EventHandlerData.php
@@ -3,13 +3,14 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
-
 declare(strict_types=1);
 
 namespace Magento\Framework\View\Helper\SecureHtmlRender;
 
 /**
  * JS event handler data.
+ *
+ * @api
  */
 class EventHandlerData
 {
diff --git a/lib/internal/Magento/Framework/View/Helper/SecureHtmlRender/SecurityProcessorInterface.php b/lib/internal/Magento/Framework/View/Helper/SecureHtmlRender/SecurityProcessorInterface.php
@@ -3,13 +3,14 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
-
 declare(strict_types=1);
 
 namespace Magento\Framework\View\Helper\SecureHtmlRender;
 
 /**
  * Perform security related modifications or logic for HTML being rendered.
+ *
+ * @api
  */
 interface SecurityProcessorInterface
 {
diff --git a/lib/internal/Magento/Framework/View/Helper/SecureHtmlRender/TagData.php b/lib/internal/Magento/Framework/View/Helper/SecureHtmlRender/TagData.php
@@ -3,13 +3,14 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
-
 declare(strict_types=1);
 
 namespace Magento\Framework\View\Helper\SecureHtmlRender;
 
 /**
  * Tag data to render.
+ *
+ * @api
  */
 class TagData
 {
diff --git a/lib/internal/Magento/Framework/View/Layout/Argument/UpdaterInterface.php b/lib/internal/Magento/Framework/View/Layout/Argument/UpdaterInterface.php
@@ -3,10 +3,14 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace Magento\Framework\View\Layout\Argument;
 
 /**
  * Interface of value modification with no value loss
+ *
+ * @api
  */
 interface UpdaterInterface
 {
diff --git a/lib/internal/Magento/Framework/View/Layout/Condition/VisibilityConditionInterface.php b/lib/internal/Magento/Framework/View/Layout/Condition/VisibilityConditionInterface.php
@@ -3,10 +3,12 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace Magento\Framework\View\Layout\Condition;
 
 /**
- * Class VisibilityConditionInterface
+ * Interface VisibilityConditionInterface
  *
  * Introduces family of visibility conditions for layout elements.
  * By using this interface a developer can specify dynamic rule for ui component visibility.
@@ -23,6 +25,8 @@
  * </uiComponent>
  *
  * "visibilityCondition" just another optional child element of ui component declaration
+ *
+ * @api
  */
 interface VisibilityConditionInterface
 {
diff --git a/lib/internal/Magento/Framework/View/Layout/GeneratorInterface.php b/lib/internal/Magento/Framework/View/Layout/GeneratorInterface.php
@@ -3,11 +3,14 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace Magento\Framework\View\Layout;
 
 /**
  * Interface \Magento\Framework\View\Layout\GeneratorInterface
  *
+ * @api
  */
 interface GeneratorInterface
 {
diff --git a/lib/internal/Magento/Framework/View/Layout/LayoutCacheKeyInterface.php b/lib/internal/Magento/Framework/View/Layout/LayoutCacheKeyInterface.php
@@ -3,10 +3,14 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace Magento\Framework\View\Layout;
 
 /**
  * Interface LayoutCacheKeyInterface
+ *
+ * @api
  */
 interface LayoutCacheKeyInterface
 {
diff --git a/lib/internal/Magento/Framework/View/Layout/ProcessorInterface.php b/lib/internal/Magento/Framework/View/Layout/ProcessorInterface.php
@@ -3,10 +3,14 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace Magento\Framework\View\Layout;
 
 /**
  * Interface ProcessorInterface
+ *
+ * @api
  */
 interface ProcessorInterface
 {
diff --git a/lib/internal/Magento/Framework/View/Layout/ReaderInterface.php b/lib/internal/Magento/Framework/View/Layout/ReaderInterface.php
@@ -3,11 +3,14 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace Magento\Framework\View\Layout;
 
 /**
  * Interface \Magento\Framework\View\Layout\ReaderInterface
  *
+ * @api
  */
 interface ReaderInterface
 {
diff --git a/lib/internal/Magento/Framework/View/Model/PageLayout/Config/BuilderInterface.php b/lib/internal/Magento/Framework/View/Model/PageLayout/Config/BuilderInterface.php
@@ -3,10 +3,14 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace Magento\Framework\View\Model\PageLayout\Config;
 
 /**
- * Interface BuilderInterface
+ * Interface Page Layout Config Builder
+ *
+ * @api
  */
 interface BuilderInterface
 {
diff --git a/lib/internal/Magento/Framework/View/Page/Config/RendererInterface.php b/lib/internal/Magento/Framework/View/Page/Config/RendererInterface.php
@@ -3,21 +3,21 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
 
 namespace Magento\Framework\View\Page\Config;
 
 /**
  * Interface RendererInterface
  *
- * @package Magento\Framework\View\Page\Config
+ * @api
  */
 interface RendererInterface
 {
     /**
      * Render Element Attributes
      *
      * @param string $elementType
-     *
      * @return string
      */
     public function renderElementAttributes($elementType);
diff --git a/lib/internal/Magento/Framework/View/PageLayout/Config.php b/lib/internal/Magento/Framework/View/PageLayout/Config.php
@@ -3,11 +3,14 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
 
 namespace Magento\Framework\View\PageLayout;
 
 /**
  * Page layouts configuration
+ *
+ * @api
  */
 class Config extends \Magento\Framework\Config\AbstractXml
 {
diff --git a/lib/internal/Magento/Framework/View/TemplateEngine/Xhtml/Compiler/AttributeInterface.php b/lib/internal/Magento/Framework/View/TemplateEngine/Xhtml/Compiler/AttributeInterface.php
@@ -3,12 +3,16 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace Magento\Framework\View\TemplateEngine\Xhtml\Compiler;
 
 use Magento\Framework\DataObject;
 
 /**
  * Interface AttributeInterface
+ *
+ * @api
  */
 interface AttributeInterface
 {
diff --git a/lib/internal/Magento/Framework/View/TemplateEngine/Xhtml/Compiler/CdataInterface.php b/lib/internal/Magento/Framework/View/TemplateEngine/Xhtml/Compiler/CdataInterface.php
@@ -3,12 +3,16 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace Magento\Framework\View\TemplateEngine\Xhtml\Compiler;
 
 use Magento\Framework\DataObject;
 
 /**
  * Interface CdataInterface
+ *
+ * @api
  */
 interface CdataInterface
 {
diff --git a/lib/internal/Magento/Framework/View/TemplateEngine/Xhtml/Compiler/CommentInterface.php b/lib/internal/Magento/Framework/View/TemplateEngine/Xhtml/Compiler/CommentInterface.php
@@ -3,12 +3,16 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace Magento\Framework\View\TemplateEngine\Xhtml\Compiler;
 
 use Magento\Framework\DataObject;
 
 /**
  * Interface CommentInterface
+ *
+ * @api
  */
 interface CommentInterface
 {
diff --git a/lib/internal/Magento/Framework/View/TemplateEngine/Xhtml/Compiler/Directive/DirectiveInterface.php b/lib/internal/Magento/Framework/View/TemplateEngine/Xhtml/Compiler/Directive/DirectiveInterface.php
@@ -3,12 +3,16 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace Magento\Framework\View\TemplateEngine\Xhtml\Compiler\Directive;
 
 use Magento\Framework\DataObject;
 
 /**
  * Interface DirectiveInterface
+ *
+ * @api
  */
 interface DirectiveInterface
 {
diff --git a/lib/internal/Magento/Framework/View/TemplateEngine/Xhtml/Compiler/Element/ElementInterface.php b/lib/internal/Magento/Framework/View/TemplateEngine/Xhtml/Compiler/Element/ElementInterface.php
@@ -3,13 +3,17 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace Magento\Framework\View\TemplateEngine\Xhtml\Compiler\Element;
 
 use Magento\Framework\DataObject;
 use Magento\Framework\View\TemplateEngine\Xhtml\CompilerInterface;
 
 /**
  * Interface ElementInterface
+ *
+ * @api
  */
 interface ElementInterface
 {
diff --git a/lib/internal/Magento/Framework/View/TemplateEngine/Xhtml/Compiler/TextInterface.php b/lib/internal/Magento/Framework/View/TemplateEngine/Xhtml/Compiler/TextInterface.php
@@ -3,12 +3,16 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace Magento\Framework\View\TemplateEngine\Xhtml\Compiler;
 
 use Magento\Framework\DataObject;
 
 /**
  * Interface TextInterface
+ *
+ * @api
  */
 interface TextInterface
 {
diff --git a/lib/internal/Magento/Framework/View/TemplateEngine/Xhtml/ResultInterface.php b/lib/internal/Magento/Framework/View/TemplateEngine/Xhtml/ResultInterface.php
@@ -3,10 +3,14 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace Magento\Framework\View\TemplateEngine\Xhtml;
 
 /**
  * Interface ResultInterface
+ *
+ * @api
  */
 interface ResultInterface
 {
diff --git a/lib/internal/Magento/Framework/View/TemplateEngineInterface.php b/lib/internal/Magento/Framework/View/TemplateEngineInterface.php
@@ -3,10 +3,14 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace Magento\Framework\View;
 
 /**
  * Interface for Template Engine
+ *
+ * @api
  */
 interface TemplateEngineInterface
 {
@@ -19,7 +23,7 @@ interface TemplateEngineInterface
      * @param \Magento\Framework\View\Element\BlockInterface $block
      * @param string $templateFile
      * @param array $dictionary
-     * @return string rendered template
+     * @return string
      */
     public function render(
         \Magento\Framework\View\Element\BlockInterface $block,
diff --git a/lib/internal/Magento/Framework/View/Xsd/Media/TypeDataExtractorInterface.php b/lib/internal/Magento/Framework/View/Xsd/Media/TypeDataExtractorInterface.php
@@ -3,10 +3,14 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace Magento\Framework\View\Xsd\Media;
 
 /**
  * Interface that encapsulates complexity of expression computation
+ *
+ * @api
  */
 interface TypeDataExtractorInterface
 {
diff --git a/lib/internal/Magento/Framework/Webapi/CustomAttribute/PreprocessorInterface.php b/lib/internal/Magento/Framework/Webapi/CustomAttribute/PreprocessorInterface.php
@@ -3,10 +3,14 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace Magento\Framework\Webapi\CustomAttribute;
 
 /**
  * Interface for attribute preprocessor
+ *
+ * @api
  */
 interface PreprocessorInterface
 {
diff --git a/lib/internal/Magento/Framework/Webapi/CustomAttribute/ServiceTypeListInterface.php b/lib/internal/Magento/Framework/Webapi/CustomAttribute/ServiceTypeListInterface.php
diff --git a/lib/internal/Magento/Framework/Webapi/Rest/Request/DeserializerInterface.php b/lib/internal/Magento/Framework/Webapi/Rest/Request/DeserializerInterface.php

Original file line number	Diff line number	Diff line change
`@@ -3,11 +3,14 @@`
`3`	`3`	`* Copyright © Magento, Inc. All rights reserved.`
`4`	`4`	`* See COPYING.txt for license details.`
`5`	`5`	`*/`
	`6`	`+declare(strict_types=1);`
	`7`	`+`
`6`	`8`	`namespace Magento\Framework\View\Layout;`
`7`	`9`
`8`	`10`	`/**`
`9`	`11`	`* Interface \Magento\Framework\View\Layout\GeneratorInterface`
`10`	`12`	`*`
	`13`	`+ * @api`
`11`	`14`	`*/`
`12`	`15`	`interface GeneratorInterface`
`13`	`16`	`{`