From bdf92f77a9b4d21a877ab6269d007bf5ad523308 Mon Sep 17 00:00:00 2001 From: aakimov Date: Mon, 27 Mar 2017 12:08:43 +0300 Subject: [PATCH 1/2] MAGETWO-66778: Api Annotation Coverage of OMS-related Modules --- .../Checkout/Block/Checkout/LayoutProcessorInterface.php | 9 +++++++++ app/code/Magento/Checkout/CustomerData/AbstractItem.php | 2 ++ app/code/Magento/Checkout/CustomerData/ItemInterface.php | 2 ++ app/code/Magento/Checkout/Model/Cart/ImageProvider.php | 1 + .../Checkout/Model/Cart/RequestInfoFilterComposite.php | 1 + .../Checkout/Model/Cart/RequestInfoFilterInterface.php | 1 + .../Magento/Checkout/Model/CompositeConfigProvider.php | 6 ++++++ .../Checkout/Model/Layout/AbstractTotalsProcessor.php | 8 ++++++++ .../Magento/Checkout/Model/Session/SuccessValidator.php | 4 +++- .../frontend/web/js/action/create-billing-address.js | 3 +++ .../frontend/web/js/action/create-shipping-address.js | 3 +++ .../frontend/web/js/action/get-payment-information.js | 3 +++ .../Checkout/view/frontend/web/js/action/get-totals.js | 3 +++ .../Checkout/view/frontend/web/js/action/place-order.js | 3 +++ .../view/frontend/web/js/action/redirect-on-success.js | 4 ++++ .../frontend/web/js/action/select-billing-address.js | 3 +++ .../view/frontend/web/js/action/select-payment-method.js | 3 +++ .../frontend/web/js/action/select-shipping-address.js | 3 +++ .../frontend/web/js/action/select-shipping-method.js | 3 +++ .../view/frontend/web/js/action/set-billing-address.js | 4 ++++ .../frontend/web/js/action/set-payment-information.js | 3 +++ .../frontend/web/js/action/set-shipping-information.js | 3 +++ .../Checkout/view/frontend/web/js/checkout-data.js | 2 ++ .../view/frontend/web/js/model/address-converter.js | 4 +++- .../view/frontend/web/js/model/error-processor.js | 3 +++ .../view/frontend/web/js/model/new-customer-address.js | 4 +++- .../web/js/model/payment/additional-validators.js | 3 +++ .../Checkout/view/frontend/web/js/model/place-order.js | 3 +++ .../Magento/Checkout/view/frontend/web/js/model/quote.js | 3 +++ .../view/frontend/web/js/model/resource-url-manager.js | 3 +++ .../web/js/model/shipping-rates-validation-rules.js | 3 +++ .../frontend/web/js/model/shipping-rates-validator.js | 3 +++ .../frontend/web/js/model/shipping-save-processor.js | 3 +++ .../view/frontend/web/js/model/step-navigator.js | 3 +++ .../Checkout/view/frontend/web/js/model/totals.js | 3 +++ .../Item/Renderer/Actions/LayoutProcessorInterface.php | 3 +++ .../view/frontend/web/js/action/gift-options.js | 3 +++ .../view/frontend/web/js/model/gift-message.js | 3 +++ .../view/frontend/web/js/model/gift-options.js | 3 +++ app/code/Magento/Persistent/Helper/Data.php | 3 +++ app/code/Magento/Persistent/Helper/Session.php | 2 ++ .../Quote/Model/Quote/Address/FreeShippingInterface.php | 3 +++ .../Quote/Model/Quote/Address/RateCollectorInterface.php | 3 +++ .../Magento/Quote/Model/Quote/Address/RateRequest.php | 1 + app/code/Magento/Quote/Model/QuoteValidator.php | 3 +++ 45 files changed, 139 insertions(+), 3 deletions(-) diff --git a/app/code/Magento/Checkout/Block/Checkout/LayoutProcessorInterface.php b/app/code/Magento/Checkout/Block/Checkout/LayoutProcessorInterface.php index 126843a3e85ea..96552882403bf 100644 --- a/app/code/Magento/Checkout/Block/Checkout/LayoutProcessorInterface.php +++ b/app/code/Magento/Checkout/Block/Checkout/LayoutProcessorInterface.php @@ -5,6 +5,15 @@ */ namespace Magento\Checkout\Block\Checkout; +/** + * Layout processor interface. + * + * Can be used to provide a custom logic for checkout JS layout preparation. + * + * @see \Magento\Checkout\Block\Onepage + * + * @api + */ interface LayoutProcessorInterface { /** diff --git a/app/code/Magento/Checkout/CustomerData/AbstractItem.php b/app/code/Magento/Checkout/CustomerData/AbstractItem.php index 0f04509505cae..3ed86f0f6f43a 100644 --- a/app/code/Magento/Checkout/CustomerData/AbstractItem.php +++ b/app/code/Magento/Checkout/CustomerData/AbstractItem.php @@ -10,6 +10,8 @@ /** * Abstract item + * + * @api */ abstract class AbstractItem implements ItemInterface { diff --git a/app/code/Magento/Checkout/CustomerData/ItemInterface.php b/app/code/Magento/Checkout/CustomerData/ItemInterface.php index d81b26de7c59a..40d30c0f190ac 100644 --- a/app/code/Magento/Checkout/CustomerData/ItemInterface.php +++ b/app/code/Magento/Checkout/CustomerData/ItemInterface.php @@ -10,6 +10,8 @@ /** * Item interface + * + * @api */ interface ItemInterface { diff --git a/app/code/Magento/Checkout/Model/Cart/ImageProvider.php b/app/code/Magento/Checkout/Model/Cart/ImageProvider.php index d9a2b7d7d662f..90090e56428f3 100644 --- a/app/code/Magento/Checkout/Model/Cart/ImageProvider.php +++ b/app/code/Magento/Checkout/Model/Cart/ImageProvider.php @@ -7,6 +7,7 @@ /** * @SuppressWarnings(PHPMD.CouplingBetweenObjects) + * @api */ class ImageProvider { diff --git a/app/code/Magento/Checkout/Model/Cart/RequestInfoFilterComposite.php b/app/code/Magento/Checkout/Model/Cart/RequestInfoFilterComposite.php index e69eb532a82bf..adbd6684756a1 100644 --- a/app/code/Magento/Checkout/Model/Cart/RequestInfoFilterComposite.php +++ b/app/code/Magento/Checkout/Model/Cart/RequestInfoFilterComposite.php @@ -8,6 +8,7 @@ /** * Class RequestInfoFilterComposite + * @api */ class RequestInfoFilterComposite implements RequestInfoFilterInterface { diff --git a/app/code/Magento/Checkout/Model/Cart/RequestInfoFilterInterface.php b/app/code/Magento/Checkout/Model/Cart/RequestInfoFilterInterface.php index 5b18c73dda5df..cbed90e3a269a 100644 --- a/app/code/Magento/Checkout/Model/Cart/RequestInfoFilterInterface.php +++ b/app/code/Magento/Checkout/Model/Cart/RequestInfoFilterInterface.php @@ -8,6 +8,7 @@ /** * Interface RequestInfoFilterInterface used by composite and leafs to implement filtering + * @api */ interface RequestInfoFilterInterface { diff --git a/app/code/Magento/Checkout/Model/CompositeConfigProvider.php b/app/code/Magento/Checkout/Model/CompositeConfigProvider.php index ec95ddcb1abfa..46669512e0c02 100644 --- a/app/code/Magento/Checkout/Model/CompositeConfigProvider.php +++ b/app/code/Magento/Checkout/Model/CompositeConfigProvider.php @@ -5,6 +5,12 @@ */ namespace Magento\Checkout\Model; +/** + * Composite checkout configuration provider. + * + * @see \Magento\Checkout\Model\ConfigProviderInterface + * @api + */ class CompositeConfigProvider implements ConfigProviderInterface { /** diff --git a/app/code/Magento/Checkout/Model/Layout/AbstractTotalsProcessor.php b/app/code/Magento/Checkout/Model/Layout/AbstractTotalsProcessor.php index 943c9685529bb..014790dab4509 100644 --- a/app/code/Magento/Checkout/Model/Layout/AbstractTotalsProcessor.php +++ b/app/code/Magento/Checkout/Model/Layout/AbstractTotalsProcessor.php @@ -7,6 +7,14 @@ use Magento\Framework\App\Config\ScopeConfigInterface; +/** + * Abstract totals processor. + * + * Can be used to process totals information that will be rendered during checkout. + * Abstract class provides sorting routing to sort total information based on configuration settings. + * + * @api + */ abstract class AbstractTotalsProcessor { /** diff --git a/app/code/Magento/Checkout/Model/Session/SuccessValidator.php b/app/code/Magento/Checkout/Model/Session/SuccessValidator.php index 0df52ad1f9a24..7a81108b055a6 100644 --- a/app/code/Magento/Checkout/Model/Session/SuccessValidator.php +++ b/app/code/Magento/Checkout/Model/Session/SuccessValidator.php @@ -6,7 +6,9 @@ namespace Magento\Checkout\Model\Session; /** - * Test is checkout session valid for success action + * Test if checkout session valid for success action + * + * @api */ class SuccessValidator { diff --git a/app/code/Magento/Checkout/view/frontend/web/js/action/create-billing-address.js b/app/code/Magento/Checkout/view/frontend/web/js/action/create-billing-address.js index 413eb528e6d65..b0e9b079be588 100644 --- a/app/code/Magento/Checkout/view/frontend/web/js/action/create-billing-address.js +++ b/app/code/Magento/Checkout/view/frontend/web/js/action/create-billing-address.js @@ -3,6 +3,9 @@ * See COPYING.txt for license details. */ +/** + * @api + */ define([ 'Magento_Checkout/js/model/address-converter' ], function (addressConverter) { diff --git a/app/code/Magento/Checkout/view/frontend/web/js/action/create-shipping-address.js b/app/code/Magento/Checkout/view/frontend/web/js/action/create-shipping-address.js index 4c1e3832d8d23..fa8f3c7226cfd 100644 --- a/app/code/Magento/Checkout/view/frontend/web/js/action/create-shipping-address.js +++ b/app/code/Magento/Checkout/view/frontend/web/js/action/create-shipping-address.js @@ -3,6 +3,9 @@ * See COPYING.txt for license details. */ +/** + * @api + */ define([ 'Magento_Customer/js/model/address-list', 'Magento_Checkout/js/model/address-converter' diff --git a/app/code/Magento/Checkout/view/frontend/web/js/action/get-payment-information.js b/app/code/Magento/Checkout/view/frontend/web/js/action/get-payment-information.js index 1749e838e56f0..ee2714882d5bd 100644 --- a/app/code/Magento/Checkout/view/frontend/web/js/action/get-payment-information.js +++ b/app/code/Magento/Checkout/view/frontend/web/js/action/get-payment-information.js @@ -3,6 +3,9 @@ * See COPYING.txt for license details. */ +/** + * @api + */ define([ 'jquery', 'Magento_Checkout/js/model/quote', diff --git a/app/code/Magento/Checkout/view/frontend/web/js/action/get-totals.js b/app/code/Magento/Checkout/view/frontend/web/js/action/get-totals.js index 72c5bdbbe546f..86c89cc524775 100644 --- a/app/code/Magento/Checkout/view/frontend/web/js/action/get-totals.js +++ b/app/code/Magento/Checkout/view/frontend/web/js/action/get-totals.js @@ -3,6 +3,9 @@ * See COPYING.txt for license details. */ +/** + * @api + */ define([ 'jquery', '../model/quote', diff --git a/app/code/Magento/Checkout/view/frontend/web/js/action/place-order.js b/app/code/Magento/Checkout/view/frontend/web/js/action/place-order.js index 4c2ab2842ddc4..cff6d732d8dc6 100644 --- a/app/code/Magento/Checkout/view/frontend/web/js/action/place-order.js +++ b/app/code/Magento/Checkout/view/frontend/web/js/action/place-order.js @@ -3,6 +3,9 @@ * See COPYING.txt for license details. */ +/** + * @api + */ define([ 'Magento_Checkout/js/model/quote', 'Magento_Checkout/js/model/url-builder', diff --git a/app/code/Magento/Checkout/view/frontend/web/js/action/redirect-on-success.js b/app/code/Magento/Checkout/view/frontend/web/js/action/redirect-on-success.js index 095012d26cd90..9959cb62c7031 100644 --- a/app/code/Magento/Checkout/view/frontend/web/js/action/redirect-on-success.js +++ b/app/code/Magento/Checkout/view/frontend/web/js/action/redirect-on-success.js @@ -2,6 +2,10 @@ * Copyright © 2013-2017 Magento, Inc. All rights reserved. * See COPYING.txt for license details. */ + +/** + * @api + */ define( [ 'mage/url' diff --git a/app/code/Magento/Checkout/view/frontend/web/js/action/select-billing-address.js b/app/code/Magento/Checkout/view/frontend/web/js/action/select-billing-address.js index b2b3b004534c8..aac29c6e4b398 100644 --- a/app/code/Magento/Checkout/view/frontend/web/js/action/select-billing-address.js +++ b/app/code/Magento/Checkout/view/frontend/web/js/action/select-billing-address.js @@ -3,6 +3,9 @@ * See COPYING.txt for license details. */ +/** + * @api + */ define([ 'jquery', '../model/quote' diff --git a/app/code/Magento/Checkout/view/frontend/web/js/action/select-payment-method.js b/app/code/Magento/Checkout/view/frontend/web/js/action/select-payment-method.js index 1b2f921e2e16e..4ece6e36f6843 100644 --- a/app/code/Magento/Checkout/view/frontend/web/js/action/select-payment-method.js +++ b/app/code/Magento/Checkout/view/frontend/web/js/action/select-payment-method.js @@ -3,6 +3,9 @@ * See COPYING.txt for license details. */ +/** + * @api + */ define([ '../model/quote' ], function (quote) { diff --git a/app/code/Magento/Checkout/view/frontend/web/js/action/select-shipping-address.js b/app/code/Magento/Checkout/view/frontend/web/js/action/select-shipping-address.js index 84a3c0fa58e75..4cea6ab25a645 100644 --- a/app/code/Magento/Checkout/view/frontend/web/js/action/select-shipping-address.js +++ b/app/code/Magento/Checkout/view/frontend/web/js/action/select-shipping-address.js @@ -3,6 +3,9 @@ * See COPYING.txt for license details. */ +/** + * @api + */ define([ 'Magento_Checkout/js/model/quote' ], function (quote) { diff --git a/app/code/Magento/Checkout/view/frontend/web/js/action/select-shipping-method.js b/app/code/Magento/Checkout/view/frontend/web/js/action/select-shipping-method.js index bad7e59111435..e5a36942c88e0 100644 --- a/app/code/Magento/Checkout/view/frontend/web/js/action/select-shipping-method.js +++ b/app/code/Magento/Checkout/view/frontend/web/js/action/select-shipping-method.js @@ -3,6 +3,9 @@ * See COPYING.txt for license details. */ +/** + * @api + */ define([ '../model/quote' ], function (quote) { diff --git a/app/code/Magento/Checkout/view/frontend/web/js/action/set-billing-address.js b/app/code/Magento/Checkout/view/frontend/web/js/action/set-billing-address.js index db5c21b797e35..823ba6c63b3ba 100644 --- a/app/code/Magento/Checkout/view/frontend/web/js/action/set-billing-address.js +++ b/app/code/Magento/Checkout/view/frontend/web/js/action/set-billing-address.js @@ -2,6 +2,10 @@ * Copyright © 2013-2017 Magento, Inc. All rights reserved. * See COPYING.txt for license details. */ + +/** + * @api + */ define( [ 'jquery', diff --git a/app/code/Magento/Checkout/view/frontend/web/js/action/set-payment-information.js b/app/code/Magento/Checkout/view/frontend/web/js/action/set-payment-information.js index 1c757bb292086..5c0dc3f502a89 100644 --- a/app/code/Magento/Checkout/view/frontend/web/js/action/set-payment-information.js +++ b/app/code/Magento/Checkout/view/frontend/web/js/action/set-payment-information.js @@ -3,6 +3,9 @@ * See COPYING.txt for license details. */ +/** + * @api + */ define([ 'Magento_Checkout/js/model/quote', 'Magento_Checkout/js/model/url-builder', diff --git a/app/code/Magento/Checkout/view/frontend/web/js/action/set-shipping-information.js b/app/code/Magento/Checkout/view/frontend/web/js/action/set-shipping-information.js index 75a4e790d9e32..a7b5d3fd4591c 100644 --- a/app/code/Magento/Checkout/view/frontend/web/js/action/set-shipping-information.js +++ b/app/code/Magento/Checkout/view/frontend/web/js/action/set-shipping-information.js @@ -3,6 +3,9 @@ * See COPYING.txt for license details. */ +/** + * @api + */ define([ '../model/quote', 'Magento_Checkout/js/model/shipping-save-processor' diff --git a/app/code/Magento/Checkout/view/frontend/web/js/checkout-data.js b/app/code/Magento/Checkout/view/frontend/web/js/checkout-data.js index 9d6d000dd9ae1..a0675e2471116 100644 --- a/app/code/Magento/Checkout/view/frontend/web/js/checkout-data.js +++ b/app/code/Magento/Checkout/view/frontend/web/js/checkout-data.js @@ -5,6 +5,8 @@ /** * Checkout adapter for customer data storage + * + * @api */ define([ 'jquery', diff --git a/app/code/Magento/Checkout/view/frontend/web/js/model/address-converter.js b/app/code/Magento/Checkout/view/frontend/web/js/model/address-converter.js index d2fd068efd1e8..fe825ea8560a3 100644 --- a/app/code/Magento/Checkout/view/frontend/web/js/model/address-converter.js +++ b/app/code/Magento/Checkout/view/frontend/web/js/model/address-converter.js @@ -2,7 +2,9 @@ * Copyright © 2013-2017 Magento, Inc. All rights reserved. * See COPYING.txt for license details. */ - +/** + * @api + */ define([ 'jquery', 'Magento_Checkout/js/model/new-customer-address', diff --git a/app/code/Magento/Checkout/view/frontend/web/js/model/error-processor.js b/app/code/Magento/Checkout/view/frontend/web/js/model/error-processor.js index f935451c953aa..2b53ae603d223 100644 --- a/app/code/Magento/Checkout/view/frontend/web/js/model/error-processor.js +++ b/app/code/Magento/Checkout/view/frontend/web/js/model/error-processor.js @@ -3,6 +3,9 @@ * See COPYING.txt for license details. */ +/** + * @api + */ define([ 'mage/url', 'Magento_Ui/js/model/messageList' diff --git a/app/code/Magento/Checkout/view/frontend/web/js/model/new-customer-address.js b/app/code/Magento/Checkout/view/frontend/web/js/model/new-customer-address.js index 5880e79941fe3..4ba99e3436dae 100644 --- a/app/code/Magento/Checkout/view/frontend/web/js/model/new-customer-address.js +++ b/app/code/Magento/Checkout/view/frontend/web/js/model/new-customer-address.js @@ -2,7 +2,9 @@ * Copyright © 2013-2017 Magento, Inc. All rights reserved. * See COPYING.txt for license details. */ - +/** + * @api + */ define([], function () { 'use strict'; diff --git a/app/code/Magento/Checkout/view/frontend/web/js/model/payment/additional-validators.js b/app/code/Magento/Checkout/view/frontend/web/js/model/payment/additional-validators.js index 0a97e91f87c79..91d82b5311ab0 100644 --- a/app/code/Magento/Checkout/view/frontend/web/js/model/payment/additional-validators.js +++ b/app/code/Magento/Checkout/view/frontend/web/js/model/payment/additional-validators.js @@ -3,6 +3,9 @@ * See COPYING.txt for license details. */ +/** + * @api + */ define([], function () { 'use strict'; diff --git a/app/code/Magento/Checkout/view/frontend/web/js/model/place-order.js b/app/code/Magento/Checkout/view/frontend/web/js/model/place-order.js index d533a963a6d20..74bebbba88747 100644 --- a/app/code/Magento/Checkout/view/frontend/web/js/model/place-order.js +++ b/app/code/Magento/Checkout/view/frontend/web/js/model/place-order.js @@ -2,6 +2,9 @@ * Copyright © 2013-2017 Magento, Inc. All rights reserved. * See COPYING.txt for license details. */ +/** + * @api + */ define( [ 'mage/storage', diff --git a/app/code/Magento/Checkout/view/frontend/web/js/model/quote.js b/app/code/Magento/Checkout/view/frontend/web/js/model/quote.js index 4dd76c5870b08..e9cc9fad0d2d6 100644 --- a/app/code/Magento/Checkout/view/frontend/web/js/model/quote.js +++ b/app/code/Magento/Checkout/view/frontend/web/js/model/quote.js @@ -2,6 +2,9 @@ * Copyright © 2013-2017 Magento, Inc. All rights reserved. * See COPYING.txt for license details. */ +/** + * @api + */ define([ 'ko', 'underscore' diff --git a/app/code/Magento/Checkout/view/frontend/web/js/model/resource-url-manager.js b/app/code/Magento/Checkout/view/frontend/web/js/model/resource-url-manager.js index fc60ed1bb5aa6..ca6d58fd03af5 100644 --- a/app/code/Magento/Checkout/view/frontend/web/js/model/resource-url-manager.js +++ b/app/code/Magento/Checkout/view/frontend/web/js/model/resource-url-manager.js @@ -3,6 +3,9 @@ * See COPYING.txt for license details. */ +/** + * @api + */ define([ 'Magento_Customer/js/model/customer', 'Magento_Checkout/js/model/url-builder', diff --git a/app/code/Magento/Checkout/view/frontend/web/js/model/shipping-rates-validation-rules.js b/app/code/Magento/Checkout/view/frontend/web/js/model/shipping-rates-validation-rules.js index 973ea12f801d8..cbd9b0133f3c3 100644 --- a/app/code/Magento/Checkout/view/frontend/web/js/model/shipping-rates-validation-rules.js +++ b/app/code/Magento/Checkout/view/frontend/web/js/model/shipping-rates-validation-rules.js @@ -3,6 +3,9 @@ * See COPYING.txt for license details. */ +/** + * @api + */ define(['jquery'], function ($) { 'use strict'; diff --git a/app/code/Magento/Checkout/view/frontend/web/js/model/shipping-rates-validator.js b/app/code/Magento/Checkout/view/frontend/web/js/model/shipping-rates-validator.js index f4f63a79152bd..8f21be4f95235 100644 --- a/app/code/Magento/Checkout/view/frontend/web/js/model/shipping-rates-validator.js +++ b/app/code/Magento/Checkout/view/frontend/web/js/model/shipping-rates-validator.js @@ -3,6 +3,9 @@ * See COPYING.txt for license details. */ +/** + * @api + */ define([ 'jquery', 'ko', diff --git a/app/code/Magento/Checkout/view/frontend/web/js/model/shipping-save-processor.js b/app/code/Magento/Checkout/view/frontend/web/js/model/shipping-save-processor.js index bba132671c4b3..47e750d941895 100644 --- a/app/code/Magento/Checkout/view/frontend/web/js/model/shipping-save-processor.js +++ b/app/code/Magento/Checkout/view/frontend/web/js/model/shipping-save-processor.js @@ -3,6 +3,9 @@ * See COPYING.txt for license details. */ +/** + * @api + */ define([ 'Magento_Checkout/js/model/shipping-save-processor/default' ], function (defaultProcessor) { diff --git a/app/code/Magento/Checkout/view/frontend/web/js/model/step-navigator.js b/app/code/Magento/Checkout/view/frontend/web/js/model/step-navigator.js index 41bc05e97ff1f..e8a654bfcba2b 100644 --- a/app/code/Magento/Checkout/view/frontend/web/js/model/step-navigator.js +++ b/app/code/Magento/Checkout/view/frontend/web/js/model/step-navigator.js @@ -3,6 +3,9 @@ * See COPYING.txt for license details. */ +/** + * @api + */ define([ 'jquery', 'ko' diff --git a/app/code/Magento/Checkout/view/frontend/web/js/model/totals.js b/app/code/Magento/Checkout/view/frontend/web/js/model/totals.js index 6dfc25bf1f3c0..348ed0c437237 100644 --- a/app/code/Magento/Checkout/view/frontend/web/js/model/totals.js +++ b/app/code/Magento/Checkout/view/frontend/web/js/model/totals.js @@ -3,6 +3,9 @@ * See COPYING.txt for license details. */ +/** + * @api + */ define([ 'ko', 'Magento_Checkout/js/model/quote' diff --git a/app/code/Magento/GiftMessage/Block/Cart/Item/Renderer/Actions/LayoutProcessorInterface.php b/app/code/Magento/GiftMessage/Block/Cart/Item/Renderer/Actions/LayoutProcessorInterface.php index 433a7007aef1a..8e733ff5d32aa 100644 --- a/app/code/Magento/GiftMessage/Block/Cart/Item/Renderer/Actions/LayoutProcessorInterface.php +++ b/app/code/Magento/GiftMessage/Block/Cart/Item/Renderer/Actions/LayoutProcessorInterface.php @@ -7,6 +7,9 @@ use Magento\Quote\Model\Quote\Item\AbstractItem; +/** + * @api + */ interface LayoutProcessorInterface { /** diff --git a/app/code/Magento/GiftMessage/view/frontend/web/js/action/gift-options.js b/app/code/Magento/GiftMessage/view/frontend/web/js/action/gift-options.js index 8c6d477ffa2ad..f554a53d53ff1 100644 --- a/app/code/Magento/GiftMessage/view/frontend/web/js/action/gift-options.js +++ b/app/code/Magento/GiftMessage/view/frontend/web/js/action/gift-options.js @@ -3,6 +3,9 @@ * See COPYING.txt for license details. */ +/** + * @api + */ define([ 'Magento_GiftMessage/js/model/url-builder', 'mage/storage', diff --git a/app/code/Magento/GiftMessage/view/frontend/web/js/model/gift-message.js b/app/code/Magento/GiftMessage/view/frontend/web/js/model/gift-message.js index f99675e065424..19d389308c449 100644 --- a/app/code/Magento/GiftMessage/view/frontend/web/js/model/gift-message.js +++ b/app/code/Magento/GiftMessage/view/frontend/web/js/model/gift-message.js @@ -3,6 +3,9 @@ * See COPYING.txt for license details. */ +/** + * @api + */ define([ 'uiElement', 'underscore', diff --git a/app/code/Magento/GiftMessage/view/frontend/web/js/model/gift-options.js b/app/code/Magento/GiftMessage/view/frontend/web/js/model/gift-options.js index 83a21f60be8c1..7f693e78cd3bd 100644 --- a/app/code/Magento/GiftMessage/view/frontend/web/js/model/gift-options.js +++ b/app/code/Magento/GiftMessage/view/frontend/web/js/model/gift-options.js @@ -3,6 +3,9 @@ * See COPYING.txt for license details. */ +/** + * @api + */ define([ 'underscore', 'ko' diff --git a/app/code/Magento/Persistent/Helper/Data.php b/app/code/Magento/Persistent/Helper/Data.php index b4c59f09c0562..5d246068664ab 100644 --- a/app/code/Magento/Persistent/Helper/Data.php +++ b/app/code/Magento/Persistent/Helper/Data.php @@ -12,6 +12,9 @@ use Magento\Framework\Module\Dir; use Magento\Store\Model\ScopeInterface; +/** + * @api + */ class Data extends \Magento\Framework\App\Helper\AbstractHelper { const XML_PATH_ENABLED = 'persistent/options/enabled'; diff --git a/app/code/Magento/Persistent/Helper/Session.php b/app/code/Magento/Persistent/Helper/Session.php index a505656d0e181..5a5e7d40d85e2 100644 --- a/app/code/Magento/Persistent/Helper/Session.php +++ b/app/code/Magento/Persistent/Helper/Session.php @@ -7,6 +7,8 @@ /** * Persistent Shopping Cart Data Helper + * + * @api */ class Session extends \Magento\Framework\App\Helper\AbstractHelper { diff --git a/app/code/Magento/Quote/Model/Quote/Address/FreeShippingInterface.php b/app/code/Magento/Quote/Model/Quote/Address/FreeShippingInterface.php index 1acaa26c183e6..3fd07737ef5e6 100644 --- a/app/code/Magento/Quote/Model/Quote/Address/FreeShippingInterface.php +++ b/app/code/Magento/Quote/Model/Quote/Address/FreeShippingInterface.php @@ -5,6 +5,9 @@ */ namespace Magento\Quote\Model\Quote\Address; +/** + * @api + */ interface FreeShippingInterface { /** diff --git a/app/code/Magento/Quote/Model/Quote/Address/RateCollectorInterface.php b/app/code/Magento/Quote/Model/Quote/Address/RateCollectorInterface.php index 958c86fb37b3f..2e75b80aac7ec 100644 --- a/app/code/Magento/Quote/Model/Quote/Address/RateCollectorInterface.php +++ b/app/code/Magento/Quote/Model/Quote/Address/RateCollectorInterface.php @@ -5,6 +5,9 @@ */ namespace Magento\Quote\Model\Quote\Address; +/** + * @api + */ interface RateCollectorInterface { /** diff --git a/app/code/Magento/Quote/Model/Quote/Address/RateRequest.php b/app/code/Magento/Quote/Model/Quote/Address/RateRequest.php index 3997029da5472..993ad2bc503f0 100644 --- a/app/code/Magento/Quote/Model/Quote/Address/RateRequest.php +++ b/app/code/Magento/Quote/Model/Quote/Address/RateRequest.php @@ -108,6 +108,7 @@ * @method string getLimitCarrier() * @method \Magento\Quote\Model\Quote\Address\RateRequest setLimitMethod(string $value) * @method string getLimitMethod() + * @api */ class RateRequest extends \Magento\Framework\DataObject { diff --git a/app/code/Magento/Quote/Model/QuoteValidator.php b/app/code/Magento/Quote/Model/QuoteValidator.php index 3d9128efaf07f..456b4ca3a7fb9 100644 --- a/app/code/Magento/Quote/Model/QuoteValidator.php +++ b/app/code/Magento/Quote/Model/QuoteValidator.php @@ -8,6 +8,9 @@ use Magento\Quote\Model\Quote as QuoteEntity; +/** + * @api + */ class QuoteValidator { /** From dd6edaec0f290dff8c077cd9bacf140bedd789ba Mon Sep 17 00:00:00 2001 From: aakimov Date: Tue, 28 Mar 2017 11:28:55 +0300 Subject: [PATCH 2/2] MAGETWO-66778: Api Annotation Coverage of OMS-related Modules - Added PHPDoc block; --- .../Cart/Item/Renderer/Actions/LayoutProcessorInterface.php | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/app/code/Magento/GiftMessage/Block/Cart/Item/Renderer/Actions/LayoutProcessorInterface.php b/app/code/Magento/GiftMessage/Block/Cart/Item/Renderer/Actions/LayoutProcessorInterface.php index 8e733ff5d32aa..af4f7944fc76b 100644 --- a/app/code/Magento/GiftMessage/Block/Cart/Item/Renderer/Actions/LayoutProcessorInterface.php +++ b/app/code/Magento/GiftMessage/Block/Cart/Item/Renderer/Actions/LayoutProcessorInterface.php @@ -8,6 +8,12 @@ use Magento\Quote\Model\Quote\Item\AbstractItem; /** + * Layout processor interface. + * + * Classes that implement this interface can be used to modify cart JS layout before rendering. + * Interface method accepts quote item, so the required data can be easily retrieved. + * @see \Magento\GiftMessage\Block\Cart\Item\Renderer\Actions\GiftOptions + * * @api */ interface LayoutProcessorInterface