From 61f8d7ea10506bbc39938848b2b136a2f4df5dca Mon Sep 17 00:00:00 2001 From: TuNa Date: Sat, 20 Feb 2021 14:35:00 +0700 Subject: [PATCH] Mark Framework interfaces as API part 1 update --- .../Framework/Amqp/Topology/BindingInstallerInterface.php | 2 ++ .../Magento/Framework/Api/AttributeTypeResolverInterface.php | 3 ++- lib/internal/Magento/Framework/Api/CriteriaInterface.php | 2 ++ .../Magento/Framework/Api/Search/AggregationInterface.php | 4 +++- .../Framework/Api/Search/AggregationValueInterface.php | 3 ++- lib/internal/Magento/Framework/Api/Search/BucketInterface.php | 4 +++- .../Magento/Framework/Api/Search/DocumentInterface.php | 3 ++- .../Magento/Framework/Api/Search/ReportingInterface.php | 2 ++ .../ConditionProcessor/CustomConditionInterface.php | 1 + .../ConditionProcessor/CustomConditionProviderInterface.php | 2 ++ lib/internal/Magento/Framework/Api/SimpleBuilderInterface.php | 2 ++ .../Framework/App/Action/HttpConnectActionInterface.php | 2 ++ .../Framework/App/Action/HttpDeleteActionInterface.php | 2 ++ .../Magento/Framework/App/Action/HttpGetActionInterface.php | 2 ++ .../Framework/App/Action/HttpOptionsActionInterface.php | 2 ++ .../Magento/Framework/App/Action/HttpPatchActionInterface.php | 2 ++ .../Magento/Framework/App/Action/HttpPostActionInterface.php | 2 ++ .../Framework/App/Action/HttpPropfindActionInterface.php | 2 ++ .../Magento/Framework/App/Action/HttpPutActionInterface.php | 2 ++ .../Magento/Framework/App/Action/HttpTraceActionInterface.php | 2 ++ lib/internal/Magento/Framework/App/AreaInterface.php | 2 ++ .../Magento/Framework/App/Config/CommentInterface.php | 2 ++ .../Magento/Framework/App/Config/CommentParserInterface.php | 2 ++ .../Framework/App/Config/ConfigResource/ConfigInterface.php | 2 ++ .../Magento/Framework/App/Config/ConfigSourceInterface.php | 2 ++ .../Magento/Framework/App/Config/ConfigTypeInterface.php | 2 ++ .../Framework/App/Config/Reader/Source/SourceInterface.php | 1 + .../Magento/Framework/App/Config/Scope/ReaderInterface.php | 1 + .../Framework/App/Config/Spi/PostProcessorInterface.php | 1 + .../Framework/App/Config/Spi/PreProcessorInterface.php | 2 ++ .../Topology/Config/ExchangeConfigItem/BindingInterface.php | 2 ++ 31 files changed, 60 insertions(+), 5 deletions(-) diff --git a/lib/internal/Magento/Framework/Amqp/Topology/BindingInstallerInterface.php b/lib/internal/Magento/Framework/Amqp/Topology/BindingInstallerInterface.php index d18b6b0ad73b9..aa467e8347886 100644 --- a/lib/internal/Magento/Framework/Amqp/Topology/BindingInstallerInterface.php +++ b/lib/internal/Magento/Framework/Amqp/Topology/BindingInstallerInterface.php @@ -10,6 +10,8 @@ /** * Exchange binding installer. + * + * @api */ interface BindingInstallerInterface { diff --git a/lib/internal/Magento/Framework/Api/AttributeTypeResolverInterface.php b/lib/internal/Magento/Framework/Api/AttributeTypeResolverInterface.php index f78cf2798aa24..51d417f5a0275 100644 --- a/lib/internal/Magento/Framework/Api/AttributeTypeResolverInterface.php +++ b/lib/internal/Magento/Framework/Api/AttributeTypeResolverInterface.php @@ -7,8 +7,9 @@ namespace Magento\Framework\Api; /** - * Interface \Magento\Framework\Api\AttributeTypeResolverInterface + * Interface Attribute Type Resolver * + * @api */ interface AttributeTypeResolverInterface { diff --git a/lib/internal/Magento/Framework/Api/CriteriaInterface.php b/lib/internal/Magento/Framework/Api/CriteriaInterface.php index ead0d31a5fbe0..b0385ccb8caea 100644 --- a/lib/internal/Magento/Framework/Api/CriteriaInterface.php +++ b/lib/internal/Magento/Framework/Api/CriteriaInterface.php @@ -7,6 +7,8 @@ /** * Interface CriteriaInterface + * + * @api */ interface CriteriaInterface { diff --git a/lib/internal/Magento/Framework/Api/Search/AggregationInterface.php b/lib/internal/Magento/Framework/Api/Search/AggregationInterface.php index 5f02006b1f1a3..fa00d701b9175 100644 --- a/lib/internal/Magento/Framework/Api/Search/AggregationInterface.php +++ b/lib/internal/Magento/Framework/Api/Search/AggregationInterface.php @@ -6,7 +6,9 @@ namespace Magento\Framework\Api\Search; /** - * Faceted data + * Interface Aggregation fo get faceted data + * + * @api */ interface AggregationInterface { diff --git a/lib/internal/Magento/Framework/Api/Search/AggregationValueInterface.php b/lib/internal/Magento/Framework/Api/Search/AggregationValueInterface.php index 0eb0b39af70ab..fc81c98a69b3f 100644 --- a/lib/internal/Magento/Framework/Api/Search/AggregationValueInterface.php +++ b/lib/internal/Magento/Framework/Api/Search/AggregationValueInterface.php @@ -6,8 +6,9 @@ namespace Magento\Framework\Api\Search; /** - * Interface \Magento\Framework\Api\Search\AggregationValueInterface + * Interface Aggregation Value * + * @api */ interface AggregationValueInterface { diff --git a/lib/internal/Magento/Framework/Api/Search/BucketInterface.php b/lib/internal/Magento/Framework/Api/Search/BucketInterface.php index 034f72258442d..8b339051f262e 100644 --- a/lib/internal/Magento/Framework/Api/Search/BucketInterface.php +++ b/lib/internal/Magento/Framework/Api/Search/BucketInterface.php @@ -6,7 +6,9 @@ namespace Magento\Framework\Api\Search; /** - * Facet Bucket + * Interface for facet Bucket + * + * @api */ interface BucketInterface { diff --git a/lib/internal/Magento/Framework/Api/Search/DocumentInterface.php b/lib/internal/Magento/Framework/Api/Search/DocumentInterface.php index e228de52aae36..66124e305edd6 100644 --- a/lib/internal/Magento/Framework/Api/Search/DocumentInterface.php +++ b/lib/internal/Magento/Framework/Api/Search/DocumentInterface.php @@ -8,8 +8,9 @@ use Magento\Framework\Api\CustomAttributesDataInterface; /** - * Interface \Magento\Framework\Api\Search\DocumentInterface + * Interface Search Document * + * @api */ interface DocumentInterface extends CustomAttributesDataInterface { diff --git a/lib/internal/Magento/Framework/Api/Search/ReportingInterface.php b/lib/internal/Magento/Framework/Api/Search/ReportingInterface.php index 46ee52f4fd697..2662096c17b01 100644 --- a/lib/internal/Magento/Framework/Api/Search/ReportingInterface.php +++ b/lib/internal/Magento/Framework/Api/Search/ReportingInterface.php @@ -7,6 +7,8 @@ /** * Interface ReportingInterface + * + * @api */ interface ReportingInterface { diff --git a/lib/internal/Magento/Framework/Api/SearchCriteria/CollectionProcessor/ConditionProcessor/CustomConditionInterface.php b/lib/internal/Magento/Framework/Api/SearchCriteria/CollectionProcessor/ConditionProcessor/CustomConditionInterface.php index 8e03d01286ff6..a83e63524423f 100644 --- a/lib/internal/Magento/Framework/Api/SearchCriteria/CollectionProcessor/ConditionProcessor/CustomConditionInterface.php +++ b/lib/internal/Magento/Framework/Api/SearchCriteria/CollectionProcessor/ConditionProcessor/CustomConditionInterface.php @@ -23,6 +23,7 @@ * AND * (CustomCondition_2 OR CustomCondition_3) * + * @api */ interface CustomConditionInterface { diff --git a/lib/internal/Magento/Framework/Api/SearchCriteria/CollectionProcessor/ConditionProcessor/CustomConditionProviderInterface.php b/lib/internal/Magento/Framework/Api/SearchCriteria/CollectionProcessor/ConditionProcessor/CustomConditionProviderInterface.php index 504db29c2a184..aca0575cc517c 100644 --- a/lib/internal/Magento/Framework/Api/SearchCriteria/CollectionProcessor/ConditionProcessor/CustomConditionProviderInterface.php +++ b/lib/internal/Magento/Framework/Api/SearchCriteria/CollectionProcessor/ConditionProcessor/CustomConditionProviderInterface.php @@ -15,6 +15,8 @@ * * Used to store processors as mapping attributeName => CustomConditionInterface * You can use di.xml to configure with any custom conditions you need + * + * @api */ interface CustomConditionProviderInterface { diff --git a/lib/internal/Magento/Framework/Api/SimpleBuilderInterface.php b/lib/internal/Magento/Framework/Api/SimpleBuilderInterface.php index d7503f4223cbb..74ecaa8590b12 100644 --- a/lib/internal/Magento/Framework/Api/SimpleBuilderInterface.php +++ b/lib/internal/Magento/Framework/Api/SimpleBuilderInterface.php @@ -8,6 +8,8 @@ /** * Base Builder interface for simple data Objects + * + * @api */ interface SimpleBuilderInterface { diff --git a/lib/internal/Magento/Framework/App/Action/HttpConnectActionInterface.php b/lib/internal/Magento/Framework/App/Action/HttpConnectActionInterface.php index 426fe584bade6..4d3e70a4de18c 100644 --- a/lib/internal/Magento/Framework/App/Action/HttpConnectActionInterface.php +++ b/lib/internal/Magento/Framework/App/Action/HttpConnectActionInterface.php @@ -12,6 +12,8 @@ /** * Marker for actions processing CONNECT requests. + * + * @api */ interface HttpConnectActionInterface extends ActionInterface { diff --git a/lib/internal/Magento/Framework/App/Action/HttpDeleteActionInterface.php b/lib/internal/Magento/Framework/App/Action/HttpDeleteActionInterface.php index 174f21cc57b4f..44d55d7e38be6 100644 --- a/lib/internal/Magento/Framework/App/Action/HttpDeleteActionInterface.php +++ b/lib/internal/Magento/Framework/App/Action/HttpDeleteActionInterface.php @@ -12,6 +12,8 @@ /** * Marker for actions processing DELETE requests. + * + * @api */ interface HttpDeleteActionInterface extends ActionInterface { diff --git a/lib/internal/Magento/Framework/App/Action/HttpGetActionInterface.php b/lib/internal/Magento/Framework/App/Action/HttpGetActionInterface.php index c3d3d2d6fd5ec..f9a07b927ddd9 100644 --- a/lib/internal/Magento/Framework/App/Action/HttpGetActionInterface.php +++ b/lib/internal/Magento/Framework/App/Action/HttpGetActionInterface.php @@ -10,6 +10,8 @@ /** * Marker for actions processing GET requests. + * + * @api */ interface HttpGetActionInterface extends HttpHeadActionInterface { diff --git a/lib/internal/Magento/Framework/App/Action/HttpOptionsActionInterface.php b/lib/internal/Magento/Framework/App/Action/HttpOptionsActionInterface.php index fa768885a3de4..6fcd49f888c3e 100644 --- a/lib/internal/Magento/Framework/App/Action/HttpOptionsActionInterface.php +++ b/lib/internal/Magento/Framework/App/Action/HttpOptionsActionInterface.php @@ -12,6 +12,8 @@ /** * Marker for actions processing OPTIONS requests. + * + * @api */ interface HttpOptionsActionInterface extends ActionInterface { diff --git a/lib/internal/Magento/Framework/App/Action/HttpPatchActionInterface.php b/lib/internal/Magento/Framework/App/Action/HttpPatchActionInterface.php index bfc1ec94adcfe..fad706611ba01 100644 --- a/lib/internal/Magento/Framework/App/Action/HttpPatchActionInterface.php +++ b/lib/internal/Magento/Framework/App/Action/HttpPatchActionInterface.php @@ -12,6 +12,8 @@ /** * Marker for actions processing PATCH requests. + * + * @api */ interface HttpPatchActionInterface extends ActionInterface { diff --git a/lib/internal/Magento/Framework/App/Action/HttpPostActionInterface.php b/lib/internal/Magento/Framework/App/Action/HttpPostActionInterface.php index a4b87ecfe8452..42edc14bb047a 100644 --- a/lib/internal/Magento/Framework/App/Action/HttpPostActionInterface.php +++ b/lib/internal/Magento/Framework/App/Action/HttpPostActionInterface.php @@ -12,6 +12,8 @@ /** * Marker for actions processing POST requests. + * + * @api */ interface HttpPostActionInterface extends ActionInterface { diff --git a/lib/internal/Magento/Framework/App/Action/HttpPropfindActionInterface.php b/lib/internal/Magento/Framework/App/Action/HttpPropfindActionInterface.php index 7ddd32c4727c4..d58183bac01b1 100644 --- a/lib/internal/Magento/Framework/App/Action/HttpPropfindActionInterface.php +++ b/lib/internal/Magento/Framework/App/Action/HttpPropfindActionInterface.php @@ -12,6 +12,8 @@ /** * Marker for actions processing PROPFIND requests. + * + * @api */ interface HttpPropfindActionInterface extends ActionInterface { diff --git a/lib/internal/Magento/Framework/App/Action/HttpPutActionInterface.php b/lib/internal/Magento/Framework/App/Action/HttpPutActionInterface.php index a83e946d9a945..13bc01483b0a6 100644 --- a/lib/internal/Magento/Framework/App/Action/HttpPutActionInterface.php +++ b/lib/internal/Magento/Framework/App/Action/HttpPutActionInterface.php @@ -12,6 +12,8 @@ /** * Marker for actions processing PUT requests. + * + * @api */ interface HttpPutActionInterface extends ActionInterface { diff --git a/lib/internal/Magento/Framework/App/Action/HttpTraceActionInterface.php b/lib/internal/Magento/Framework/App/Action/HttpTraceActionInterface.php index b776ab061e66d..fc591c7a07cea 100644 --- a/lib/internal/Magento/Framework/App/Action/HttpTraceActionInterface.php +++ b/lib/internal/Magento/Framework/App/Action/HttpTraceActionInterface.php @@ -12,6 +12,8 @@ /** * Marker for actions processing TRACE requests. + * + * @api */ interface HttpTraceActionInterface extends ActionInterface { diff --git a/lib/internal/Magento/Framework/App/AreaInterface.php b/lib/internal/Magento/Framework/App/AreaInterface.php index b7e36b59a62d8..437f559e1230a 100644 --- a/lib/internal/Magento/Framework/App/AreaInterface.php +++ b/lib/internal/Magento/Framework/App/AreaInterface.php @@ -8,6 +8,8 @@ /** * Interface AreaInterface + * + * @api */ interface AreaInterface { diff --git a/lib/internal/Magento/Framework/App/Config/CommentInterface.php b/lib/internal/Magento/Framework/App/Config/CommentInterface.php index e8a119570ac92..b0eb93a7196f4 100644 --- a/lib/internal/Magento/Framework/App/Config/CommentInterface.php +++ b/lib/internal/Magento/Framework/App/Config/CommentInterface.php @@ -9,6 +9,8 @@ /** * Interface CommentInterface + * + * @api */ interface CommentInterface { diff --git a/lib/internal/Magento/Framework/App/Config/CommentParserInterface.php b/lib/internal/Magento/Framework/App/Config/CommentParserInterface.php index e88ea631d1889..b4f2a3b9e6321 100644 --- a/lib/internal/Magento/Framework/App/Config/CommentParserInterface.php +++ b/lib/internal/Magento/Framework/App/Config/CommentParserInterface.php @@ -9,6 +9,8 @@ /** * Interface for parsing comments in the configuration file. + * + * @api */ interface CommentParserInterface { diff --git a/lib/internal/Magento/Framework/App/Config/ConfigResource/ConfigInterface.php b/lib/internal/Magento/Framework/App/Config/ConfigResource/ConfigInterface.php index 641da1d420a96..f5b29a0633072 100644 --- a/lib/internal/Magento/Framework/App/Config/ConfigResource/ConfigInterface.php +++ b/lib/internal/Magento/Framework/App/Config/ConfigResource/ConfigInterface.php @@ -9,6 +9,8 @@ /** * Resource for storing store configuration values + * + * @api */ interface ConfigInterface { diff --git a/lib/internal/Magento/Framework/App/Config/ConfigSourceInterface.php b/lib/internal/Magento/Framework/App/Config/ConfigSourceInterface.php index ef8a6426a0e3a..597112f2ed857 100644 --- a/lib/internal/Magento/Framework/App/Config/ConfigSourceInterface.php +++ b/lib/internal/Magento/Framework/App/Config/ConfigSourceInterface.php @@ -9,6 +9,8 @@ /** * Interface ConfigSourceInterface + * + * @api */ interface ConfigSourceInterface { diff --git a/lib/internal/Magento/Framework/App/Config/ConfigTypeInterface.php b/lib/internal/Magento/Framework/App/Config/ConfigTypeInterface.php index 4982aeb498910..93e82f2d8e898 100644 --- a/lib/internal/Magento/Framework/App/Config/ConfigTypeInterface.php +++ b/lib/internal/Magento/Framework/App/Config/ConfigTypeInterface.php @@ -9,6 +9,8 @@ /** * Interface ConfigTypeInterface + * + * @api */ interface ConfigTypeInterface { diff --git a/lib/internal/Magento/Framework/App/Config/Reader/Source/SourceInterface.php b/lib/internal/Magento/Framework/App/Config/Reader/Source/SourceInterface.php index dea3fb3dee78e..16361774fd59a 100644 --- a/lib/internal/Magento/Framework/App/Config/Reader/Source/SourceInterface.php +++ b/lib/internal/Magento/Framework/App/Config/Reader/Source/SourceInterface.php @@ -9,6 +9,7 @@ * Provide access to data. Each Source can be responsible for each storage, where config data can be placed * * @package Magento\Framework\App\Config\Reader\Source + * @api */ interface SourceInterface { diff --git a/lib/internal/Magento/Framework/App/Config/Scope/ReaderInterface.php b/lib/internal/Magento/Framework/App/Config/Scope/ReaderInterface.php index fbc34e4a510bf..c0988ec911fd7 100644 --- a/lib/internal/Magento/Framework/App/Config/Scope/ReaderInterface.php +++ b/lib/internal/Magento/Framework/App/Config/Scope/ReaderInterface.php @@ -10,6 +10,7 @@ /** * Interface \Magento\Framework\App\Config\Scope\ReaderInterface * + * @api */ interface ReaderInterface { diff --git a/lib/internal/Magento/Framework/App/Config/Spi/PostProcessorInterface.php b/lib/internal/Magento/Framework/App/Config/Spi/PostProcessorInterface.php index c5aae224d136b..939dc1f31baa6 100644 --- a/lib/internal/Magento/Framework/App/Config/Spi/PostProcessorInterface.php +++ b/lib/internal/Magento/Framework/App/Config/Spi/PostProcessorInterface.php @@ -14,6 +14,7 @@ * @see SourceInterface * @see ConfigTypeInterface * @package Magento\Framework\App\Config\Spi + * @api */ interface PostProcessorInterface { diff --git a/lib/internal/Magento/Framework/App/Config/Spi/PreProcessorInterface.php b/lib/internal/Magento/Framework/App/Config/Spi/PreProcessorInterface.php index 450f582a12f23..9605b67913a98 100644 --- a/lib/internal/Magento/Framework/App/Config/Spi/PreProcessorInterface.php +++ b/lib/internal/Magento/Framework/App/Config/Spi/PreProcessorInterface.php @@ -7,6 +7,8 @@ /** * Allows to use custom callbacks and functions before applying fallback + * + * @api */ interface PreProcessorInterface { diff --git a/lib/internal/Magento/Framework/MessageQueue/Topology/Config/ExchangeConfigItem/BindingInterface.php b/lib/internal/Magento/Framework/MessageQueue/Topology/Config/ExchangeConfigItem/BindingInterface.php index d6a5689f5b43c..e29339e68f420 100644 --- a/lib/internal/Magento/Framework/MessageQueue/Topology/Config/ExchangeConfigItem/BindingInterface.php +++ b/lib/internal/Magento/Framework/MessageQueue/Topology/Config/ExchangeConfigItem/BindingInterface.php @@ -7,6 +7,8 @@ /** * Instances of this interface represent config binging items declared in etc/queue_topology.xsd + * + * @api */ interface BindingInterface {