Merge pull request #1025 from magento-folks/api_coverage

[Folks] Api Annotation Coverage of OMS-related Modules
magento · Apr 14, 2017 · 6e95f7f · 6e95f7f
2 parents 6fe5623 + b75a39d
commit 6e95f7f
Show file tree

Hide file tree

Showing 44 changed files with 144 additions and 3 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -2,6 +2,10 @@
  * Copyright © 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -2,6 +2,10 @@
  * Copyright © 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
@@ -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
@@ -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
@@ -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
@@ -2,7 +2,9 @@
  * Copyright © 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
@@ -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
@@ -2,7 +2,9 @@
  * Copyright © 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
@@ -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
@@ -2,6 +2,9 @@
  * Copyright © 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
@@ -2,6 +2,9 @@
  * Copyright © 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -7,6 +7,15 @@
 
 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
 {
     /**

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
@@ -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
@@ -3,6 +3,9 @@
  * See COPYING.txt for license details.
  */
 
+/**
+ * @api
+ */
 define([
     'uiElement',
     'underscore',