Skip to content

Commit 6e95f7f

Browse files
author
Alexander Akimov
authored
Merge pull request #1025 from magento-folks/api_coverage
[Folks] Api Annotation Coverage of OMS-related Modules
2 parents 6fe5623 + b75a39d commit 6e95f7f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+144
-3
lines changed

app/code/Magento/Checkout/Block/Checkout/LayoutProcessorInterface.php

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,15 @@
55
*/
66
namespace Magento\Checkout\Block\Checkout;
77

8+
/**
9+
* Layout processor interface.
10+
*
11+
* Can be used to provide a custom logic for checkout JS layout preparation.
12+
*
13+
* @see \Magento\Checkout\Block\Onepage
14+
*
15+
* @api
16+
*/
817
interface LayoutProcessorInterface
918
{
1019
/**

app/code/Magento/Checkout/CustomerData/AbstractItem.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@
1010

1111
/**
1212
* Abstract item
13+
*
14+
* @api
1315
*/
1416
abstract class AbstractItem implements ItemInterface
1517
{

app/code/Magento/Checkout/CustomerData/ItemInterface.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@
1010

1111
/**
1212
* Item interface
13+
*
14+
* @api
1315
*/
1416
interface ItemInterface
1517
{

app/code/Magento/Checkout/Model/Cart/ImageProvider.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77

88
/**
99
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
10+
* @api
1011
*/
1112
class ImageProvider
1213
{

app/code/Magento/Checkout/Model/Cart/RequestInfoFilterComposite.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88

99
/**
1010
* Class RequestInfoFilterComposite
11+
* @api
1112
*/
1213
class RequestInfoFilterComposite implements RequestInfoFilterInterface
1314
{

app/code/Magento/Checkout/Model/Cart/RequestInfoFilterInterface.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88

99
/**
1010
* Interface RequestInfoFilterInterface used by composite and leafs to implement filtering
11+
* @api
1112
*/
1213
interface RequestInfoFilterInterface
1314
{

app/code/Magento/Checkout/Model/CompositeConfigProvider.php

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@
55
*/
66
namespace Magento\Checkout\Model;
77

8+
/**
9+
* Composite checkout configuration provider.
10+
*
11+
* @see \Magento\Checkout\Model\ConfigProviderInterface
12+
* @api
13+
*/
814
class CompositeConfigProvider implements ConfigProviderInterface
915
{
1016
/**

app/code/Magento/Checkout/Model/Layout/AbstractTotalsProcessor.php

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,14 @@
77

88
use Magento\Framework\App\Config\ScopeConfigInterface;
99

10+
/**
11+
* Abstract totals processor.
12+
*
13+
* Can be used to process totals information that will be rendered during checkout.
14+
* Abstract class provides sorting routing to sort total information based on configuration settings.
15+
*
16+
* @api
17+
*/
1018
abstract class AbstractTotalsProcessor
1119
{
1220
/**

app/code/Magento/Checkout/Model/Session/SuccessValidator.php

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@
66
namespace Magento\Checkout\Model\Session;
77

88
/**
9-
* Test is checkout session valid for success action
9+
* Test if checkout session valid for success action
10+
*
11+
* @api
1012
*/
1113
class SuccessValidator
1214
{

app/code/Magento/Checkout/view/frontend/web/js/action/create-billing-address.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
* See COPYING.txt for license details.
44
*/
55

6+
/**
7+
* @api
8+
*/
69
define([
710
'Magento_Checkout/js/model/address-converter'
811
], function (addressConverter) {

app/code/Magento/Checkout/view/frontend/web/js/action/create-shipping-address.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
* See COPYING.txt for license details.
44
*/
55

6+
/**
7+
* @api
8+
*/
69
define([
710
'Magento_Customer/js/model/address-list',
811
'Magento_Checkout/js/model/address-converter'

app/code/Magento/Checkout/view/frontend/web/js/action/get-payment-information.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
* See COPYING.txt for license details.
44
*/
55

6+
/**
7+
* @api
8+
*/
69
define([
710
'jquery',
811
'Magento_Checkout/js/model/quote',

app/code/Magento/Checkout/view/frontend/web/js/action/get-totals.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
* See COPYING.txt for license details.
44
*/
55

6+
/**
7+
* @api
8+
*/
69
define([
710
'jquery',
811
'../model/quote',

app/code/Magento/Checkout/view/frontend/web/js/action/place-order.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
* See COPYING.txt for license details.
44
*/
55

6+
/**
7+
* @api
8+
*/
69
define([
710
'Magento_Checkout/js/model/quote',
811
'Magento_Checkout/js/model/url-builder',

app/code/Magento/Checkout/view/frontend/web/js/action/redirect-on-success.js

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22
* Copyright © Magento, Inc. All rights reserved.
33
* See COPYING.txt for license details.
44
*/
5+
6+
/**
7+
* @api
8+
*/
59
define(
610
[
711
'mage/url'

app/code/Magento/Checkout/view/frontend/web/js/action/select-billing-address.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
* See COPYING.txt for license details.
44
*/
55

6+
/**
7+
* @api
8+
*/
69
define([
710
'jquery',
811
'../model/quote'

app/code/Magento/Checkout/view/frontend/web/js/action/select-payment-method.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
* See COPYING.txt for license details.
44
*/
55

6+
/**
7+
* @api
8+
*/
69
define([
710
'../model/quote'
811
], function (quote) {

app/code/Magento/Checkout/view/frontend/web/js/action/select-shipping-address.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
* See COPYING.txt for license details.
44
*/
55

6+
/**
7+
* @api
8+
*/
69
define([
710
'Magento_Checkout/js/model/quote'
811
], function (quote) {

app/code/Magento/Checkout/view/frontend/web/js/action/select-shipping-method.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
* See COPYING.txt for license details.
44
*/
55

6+
/**
7+
* @api
8+
*/
69
define([
710
'../model/quote'
811
], function (quote) {

app/code/Magento/Checkout/view/frontend/web/js/action/set-billing-address.js

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22
* Copyright © Magento, Inc. All rights reserved.
33
* See COPYING.txt for license details.
44
*/
5+
6+
/**
7+
* @api
8+
*/
59
define(
610
[
711
'jquery',

app/code/Magento/Checkout/view/frontend/web/js/action/set-payment-information.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
* See COPYING.txt for license details.
44
*/
55

6+
/**
7+
* @api
8+
*/
69
define([
710
'Magento_Checkout/js/model/quote',
811
'Magento_Checkout/js/model/url-builder',

app/code/Magento/Checkout/view/frontend/web/js/action/set-shipping-information.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
* See COPYING.txt for license details.
44
*/
55

6+
/**
7+
* @api
8+
*/
69
define([
710
'../model/quote',
811
'Magento_Checkout/js/model/shipping-save-processor'

app/code/Magento/Checkout/view/frontend/web/js/checkout-data.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55

66
/**
77
* Checkout adapter for customer data storage
8+
*
9+
* @api
810
*/
911
define([
1012
'jquery',

app/code/Magento/Checkout/view/frontend/web/js/model/address-converter.js

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22
* Copyright © Magento, Inc. All rights reserved.
33
* See COPYING.txt for license details.
44
*/
5-
5+
/**
6+
* @api
7+
*/
68
define([
79
'jquery',
810
'Magento_Checkout/js/model/new-customer-address',

app/code/Magento/Checkout/view/frontend/web/js/model/error-processor.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
* See COPYING.txt for license details.
44
*/
55

6+
/**
7+
* @api
8+
*/
69
define([
710
'mage/url',
811
'Magento_Ui/js/model/messageList'

app/code/Magento/Checkout/view/frontend/web/js/model/new-customer-address.js

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22
* Copyright © Magento, Inc. All rights reserved.
33
* See COPYING.txt for license details.
44
*/
5-
5+
/**
6+
* @api
7+
*/
68
define([], function () {
79
'use strict';
810

app/code/Magento/Checkout/view/frontend/web/js/model/payment/additional-validators.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
* See COPYING.txt for license details.
44
*/
55

6+
/**
7+
* @api
8+
*/
69
define([], function () {
710
'use strict';
811

app/code/Magento/Checkout/view/frontend/web/js/model/place-order.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
* Copyright © Magento, Inc. All rights reserved.
33
* See COPYING.txt for license details.
44
*/
5+
/**
6+
* @api
7+
*/
58
define(
69
[
710
'mage/storage',

app/code/Magento/Checkout/view/frontend/web/js/model/quote.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
* Copyright © Magento, Inc. All rights reserved.
33
* See COPYING.txt for license details.
44
*/
5+
/**
6+
* @api
7+
*/
58
define([
69
'ko',
710
'underscore'

app/code/Magento/Checkout/view/frontend/web/js/model/resource-url-manager.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
* See COPYING.txt for license details.
44
*/
55

6+
/**
7+
* @api
8+
*/
69
define([
710
'Magento_Customer/js/model/customer',
811
'Magento_Checkout/js/model/url-builder',

app/code/Magento/Checkout/view/frontend/web/js/model/shipping-rates-validation-rules.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
* See COPYING.txt for license details.
44
*/
55

6+
/**
7+
* @api
8+
*/
69
define(['jquery'], function ($) {
710
'use strict';
811

app/code/Magento/Checkout/view/frontend/web/js/model/shipping-rates-validator.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
* See COPYING.txt for license details.
44
*/
55

6+
/**
7+
* @api
8+
*/
69
define([
710
'jquery',
811
'ko',

app/code/Magento/Checkout/view/frontend/web/js/model/shipping-save-processor.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
* See COPYING.txt for license details.
44
*/
55

6+
/**
7+
* @api
8+
*/
69
define([
710
'Magento_Checkout/js/model/shipping-save-processor/default'
811
], function (defaultProcessor) {

app/code/Magento/Checkout/view/frontend/web/js/model/step-navigator.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
* See COPYING.txt for license details.
44
*/
55

6+
/**
7+
* @api
8+
*/
69
define([
710
'jquery',
811
'ko'

app/code/Magento/Checkout/view/frontend/web/js/model/totals.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
* See COPYING.txt for license details.
44
*/
55

6+
/**
7+
* @api
8+
*/
69
define([
710
'ko',
811
'Magento_Checkout/js/model/quote'

app/code/Magento/GiftMessage/Block/Cart/Item/Renderer/Actions/LayoutProcessorInterface.php

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,15 @@
77

88
use Magento\Quote\Model\Quote\Item\AbstractItem;
99

10+
/**
11+
* Layout processor interface.
12+
*
13+
* Classes that implement this interface can be used to modify cart JS layout before rendering.
14+
* Interface method accepts quote item, so the required data can be easily retrieved.
15+
* @see \Magento\GiftMessage\Block\Cart\Item\Renderer\Actions\GiftOptions
16+
*
17+
* @api
18+
*/
1019
interface LayoutProcessorInterface
1120
{
1221
/**

app/code/Magento/GiftMessage/view/frontend/web/js/action/gift-options.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
* See COPYING.txt for license details.
44
*/
55

6+
/**
7+
* @api
8+
*/
69
define([
710
'Magento_GiftMessage/js/model/url-builder',
811
'mage/storage',

app/code/Magento/GiftMessage/view/frontend/web/js/model/gift-message.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
* See COPYING.txt for license details.
44
*/
55

6+
/**
7+
* @api
8+
*/
69
define([
710
'uiElement',
811
'underscore',

0 commit comments

Comments
 (0)