MAGETWO-66833: API annotation coverage (Magento/Customer)

slavvka · slavvka · commit 8730ac285e95 · 2017-04-07T19:37:23.000+03:00
diff --git a/app/code/Magento/Customer/CustomerData/JsLayoutDataProviderInterface.php b/app/code/Magento/Customer/CustomerData/JsLayoutDataProviderInterface.php
@@ -8,6 +8,8 @@
 
 /**
  * Js layout data provider interface
+ *
+ * @api
  */
 interface JsLayoutDataProviderInterface
 {
diff --git a/app/code/Magento/Customer/CustomerData/JsLayoutDataProviderPool.php b/app/code/Magento/Customer/CustomerData/JsLayoutDataProviderPool.php
@@ -8,6 +8,8 @@
 
 /**
  * Js layout data provider pool
+ *
+ * @api
  */
 class JsLayoutDataProviderPool implements JsLayoutDataProviderPoolInterface
 {
diff --git a/app/code/Magento/Customer/CustomerData/JsLayoutDataProviderPoolInterface.php b/app/code/Magento/Customer/CustomerData/JsLayoutDataProviderPoolInterface.php
@@ -8,6 +8,8 @@
 
 /**
  * Js layout data provider pool interface
+ *
+ * @api
  */
 interface JsLayoutDataProviderPoolInterface
 {
diff --git a/app/code/Magento/Customer/CustomerData/SectionPool.php b/app/code/Magento/Customer/CustomerData/SectionPool.php
@@ -10,6 +10,8 @@
 
 /**
  * Section pool
+ *
+ * @api
  */
 class SectionPool implements SectionPoolInterface
 {
diff --git a/app/code/Magento/Customer/CustomerData/SectionPoolInterface.php b/app/code/Magento/Customer/CustomerData/SectionPoolInterface.php
@@ -7,6 +7,8 @@
 
 /**
  * Section pool interface
+ *
+ * @api Use to collect data sections in customer data which are transported from backend to frontend local storage
  */
 interface SectionPoolInterface
 {
diff --git a/app/code/Magento/Customer/CustomerData/SectionSourceInterface.php b/app/code/Magento/Customer/CustomerData/SectionSourceInterface.php
@@ -7,6 +7,8 @@
 
 /**
  * Section source interface
+ *
+ * @api Use to define data sections in customer data which are transported from backend to frontend local storage
  */
 interface SectionSourceInterface
 {
diff --git a/app/code/Magento/Customer/Model/Address/AbstractAddress.php b/app/code/Magento/Customer/Model/Address/AbstractAddress.php
@@ -30,6 +30,8 @@
  * @method string getPostcode()
  * @method bool getShouldIgnoreValidation()
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
+ *
+ * @api
  */
 class AbstractAddress extends AbstractExtensibleModel implements AddressModelInterface
 {
diff --git a/app/code/Magento/Customer/Model/Address/AddressModelInterface.php b/app/code/Magento/Customer/Model/Address/AddressModelInterface.php
@@ -8,6 +8,8 @@
 
 /**
  * Interface AddressInterface
+ *
+ * @api
  */
 interface AddressModelInterface
 {
diff --git a/app/code/Magento/Customer/Model/Address/CustomAttributeListInterface.php b/app/code/Magento/Customer/Model/Address/CustomAttributeListInterface.php
@@ -5,6 +5,9 @@
  */
 namespace Magento\Customer\Model\Address;
 
+/**
+ * @api
+ */
 interface CustomAttributeListInterface
 {
     /**
diff --git a/app/code/Magento/Customer/Model/Customer/Source/GroupSourceInterface.php b/app/code/Magento/Customer/Model/Customer/Source/GroupSourceInterface.php
@@ -7,6 +7,9 @@
 
 use Magento\Framework\Data\OptionSourceInterface;
 
+/**
+ * @api
+ */
 interface GroupSourceInterface extends OptionSourceInterface
 {
 
diff --git a/app/code/Magento/Customer/Model/EmailNotificationInterface.php b/app/code/Magento/Customer/Model/EmailNotificationInterface.php
@@ -8,6 +8,9 @@
 use Magento\Customer\Api\Data\CustomerInterface;
 use Magento\Framework\Exception\LocalizedException;
 
+/**
+ * @api
+ */
 interface EmailNotificationInterface
 {
     /**
diff --git a/app/code/Magento/Customer/Ui/Component/Listing/Column/Actions.php b/app/code/Magento/Customer/Ui/Component/Listing/Column/Actions.php
@@ -12,6 +12,8 @@
 
 /**
  * Class ProductActions
+ *
+ * @api
  */
 class Actions extends Column
 {
diff --git a/app/code/Magento/Customer/etc/di.xml b/app/code/Magento/Customer/etc/di.xml
@@ -329,6 +329,7 @@
             <argument name="collectionProcessor" xsi:type="object">Magento\Eav\Model\Api\SearchCriteria\CollectionProcessor</argument>
         </arguments>
     </type>
+    <!-- @api -->
     <virtualType name="Magento\Customer\Model\Api\SearchCriteria\CollectionProcessor\GroupFilterProcessor" type="Magento\Framework\Api\SearchCriteria\CollectionProcessor\FilterProcessor">
         <arguments>
             <argument name="fieldMapping" xsi:type="array">
@@ -338,6 +339,7 @@
             </argument>
         </arguments>
     </virtualType>
+    <!-- @api -->
     <virtualType name="Magento\Customer\Model\Api\SearchCriteria\CollectionProcessor\GroupSortingProcessor" type="Magento\Framework\Api\SearchCriteria\CollectionProcessor\SortingProcessor">
         <arguments>
             <argument name="fieldMapping" xsi:type="array">
@@ -350,6 +352,7 @@
             </argument>
         </arguments>
     </virtualType>
+    <!-- @api -->
     <virtualType name="Magento\Customer\Model\Api\SearchCriteria\GroupCollectionProcessor" type="Magento\Framework\Api\SearchCriteria\CollectionProcessor">
         <arguments>
             <argument name="processors" xsi:type="array">
diff --git a/app/code/Magento/Customer/view/frontend/web/js/customer-data.js b/app/code/Magento/Customer/view/frontend/web/js/customer-data.js
@@ -3,6 +3,9 @@
  * See COPYING.txt for license details.
  */
 
+/**
+ * @api
+ */
 define([
     'jquery',
     'underscore',
diff --git a/app/code/Magento/Customer/view/frontend/web/js/model/address-list.js b/app/code/Magento/Customer/view/frontend/web/js/model/address-list.js
@@ -3,6 +3,9 @@
  * See COPYING.txt for license details.
  */
 
+/**
+ * @api
+ */
 define([
     'ko',
     './customer-addresses'
diff --git a/app/code/Magento/Customer/view/frontend/web/js/model/customer-addresses.js b/app/code/Magento/Customer/view/frontend/web/js/model/customer-addresses.js
@@ -3,6 +3,9 @@
  * See COPYING.txt for license details.
  */
 
+/**
+ * @api
+ */
 define([
     'jquery',
     'ko',
diff --git a/app/code/Magento/Customer/view/frontend/web/js/model/customer.js b/app/code/Magento/Customer/view/frontend/web/js/model/customer.js
@@ -3,6 +3,9 @@
  * See COPYING.txt for license details.
  */
 
+/**
+ * @api
+ */
 define([
     'jquery',
     'ko',
diff --git a/app/code/Magento/Customer/view/frontend/web/js/model/customer/address.js b/app/code/Magento/Customer/view/frontend/web/js/model/customer/address.js
@@ -3,6 +3,9 @@
  * See COPYING.txt for license details.
  */
 
+/**
+ * @api
+ */
 define([], function () {
     'use strict';
 

Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,8 @@`
`8`	`8`
`9`	`9`	`/**`
`10`	`10`	`* Js layout data provider interface`
	`11`	`+ *`
	`12`	`+ * @api`
`11`	`13`	`*/`
`12`	`14`	`interface JsLayoutDataProviderInterface`
`13`	`15`	`{`
Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,8 @@`
`10`	`10`
`11`	`11`	`/**`
`12`	`12`	`* Section pool`
	`13`	`+ *`
	`14`	`+ * @api`
`13`	`15`	`*/`
`14`	`16`	`class SectionPool implements SectionPoolInterface`
`15`	`17`	`{`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,8 @@`
`7`	`7`
`8`	`8`	`/**`
`9`	`9`	`* Section pool interface`
	`10`	`+ *`
	`11`	`+ * @api Use to collect data sections in customer data which are transported from backend to frontend local storage`
`10`	`12`	`*/`
`11`	`13`	`interface SectionPoolInterface`
`12`	`14`	`{`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,8 @@`
`7`	`7`
`8`	`8`	`/**`
`9`	`9`	`* Section source interface`
	`10`	`+ *`
	`11`	`+ * @api Use to define data sections in customer data which are transported from backend to frontend local storage`
`10`	`12`	`*/`
`11`	`13`	`interface SectionSourceInterface`
`12`	`14`	`{`
Original file line number	Diff line number	Diff line change
`@@ -30,6 +30,8 @@`
`30`	`30`	`* @method string getPostcode()`
`31`	`31`	`* @method bool getShouldIgnoreValidation()`
`32`	`32`	`* @SuppressWarnings(PHPMD.CouplingBetweenObjects)`
	`33`	`+ *`
	`34`	`+ * @api`
`33`	`35`	`*/`
`34`	`36`	`class AbstractAddress extends AbstractExtensibleModel implements AddressModelInterface`
`35`	`37`	`{`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,9 @@`
`5`	`5`	`*/`
`6`	`6`	`namespace Magento\Customer\Model\Address;`
`7`	`7`
	`8`	`+/**`
	`9`	`+ * @api`
	`10`	`+ */`
`8`	`11`	`interface CustomAttributeListInterface`
`9`	`12`	`{`
`10`	`13`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,9 @@`
`7`	`7`
`8`	`8`	`use Magento\Framework\Data\OptionSourceInterface;`
`9`	`9`
	`10`	`+/**`
	`11`	`+ * @api`
	`12`	`+ */`
`10`	`13`	`interface GroupSourceInterface extends OptionSourceInterface`
`11`	`14`	`{`
`12`	`15`