MAGETWO-32634: Define Public API - Fearless Kiwi (CS)

Mike Weis · Mike Weis · commit ba7a66470fb2 · 2015-05-06T09:41:28.000-05:00
- add interface PhpDoc
diff --git a/app/code/Magento/Tax/Api/Data/AppliedTaxInterface.php b/app/code/Magento/Tax/Api/Data/AppliedTaxInterface.php
@@ -6,6 +6,7 @@
 namespace Magento\Tax\Api\Data;
 
 /**
+ * Applied tax interface.
  * @api
  */
 interface AppliedTaxInterface extends \Magento\Framework\Api\ExtensibleDataInterface
diff --git a/app/code/Magento/Tax/Api/Data/AppliedTaxRateInterface.php b/app/code/Magento/Tax/Api/Data/AppliedTaxRateInterface.php
@@ -7,6 +7,7 @@
 namespace Magento\Tax\Api\Data;
 
 /**
+ * Applied tax rate interface.
  * @api
  */
 interface AppliedTaxRateInterface extends \Magento\Framework\Api\ExtensibleDataInterface
diff --git a/app/code/Magento/Tax/Api/Data/QuoteDetailsInterface.php b/app/code/Magento/Tax/Api/Data/QuoteDetailsInterface.php
@@ -7,6 +7,7 @@
 namespace Magento\Tax\Api\Data;
 
 /**
+ * Quote details interface.
  * @api
  */
 interface QuoteDetailsInterface extends \Magento\Framework\Api\ExtensibleDataInterface
diff --git a/app/code/Magento/Tax/Api/Data/QuoteDetailsItemInterface.php b/app/code/Magento/Tax/Api/Data/QuoteDetailsItemInterface.php
@@ -6,6 +6,7 @@
 namespace Magento\Tax\Api\Data;
 
 /**
+ * Quote details item interface.
  * @api
  */
 interface QuoteDetailsItemInterface extends \Magento\Framework\Api\ExtensibleDataInterface
diff --git a/app/code/Magento/Tax/Api/Data/TaxClassInterface.php b/app/code/Magento/Tax/Api/Data/TaxClassInterface.php
@@ -8,6 +8,7 @@
 namespace Magento\Tax\Api\Data;
 
 /**
+ * Tax class interface.
  * @api
  */
 interface TaxClassInterface extends \Magento\Framework\Api\ExtensibleDataInterface
diff --git a/app/code/Magento/Tax/Api/Data/TaxClassKeyInterface.php b/app/code/Magento/Tax/Api/Data/TaxClassKeyInterface.php
@@ -9,6 +9,7 @@
 use Magento\Framework\Api\ExtensibleDataInterface;
 
 /**
+ * Tax class key interface.
  * @api
  */
 interface TaxClassKeyInterface extends ExtensibleDataInterface
diff --git a/app/code/Magento/Tax/Api/Data/TaxClassSearchResultsInterface.php b/app/code/Magento/Tax/Api/Data/TaxClassSearchResultsInterface.php
@@ -7,6 +7,7 @@
 namespace Magento\Tax\Api\Data;
 
 /**
+ * Interface for tax class search results.
  * @api
  */
 interface TaxClassSearchResultsInterface extends \Magento\Framework\Api\SearchResultsInterface
diff --git a/app/code/Magento/Tax/Api/Data/TaxDetailsInterface.php b/app/code/Magento/Tax/Api/Data/TaxDetailsInterface.php
@@ -7,6 +7,7 @@
 namespace Magento\Tax\Api\Data;
 
 /**
+ * Tax details interface.
  * @api
  */
 interface TaxDetailsInterface extends \Magento\Framework\Api\ExtensibleDataInterface
diff --git a/app/code/Magento/Tax/Api/Data/TaxDetailsItemInterface.php b/app/code/Magento/Tax/Api/Data/TaxDetailsItemInterface.php
@@ -7,6 +7,7 @@
 namespace Magento\Tax\Api\Data;
 
 /**
+ * Tax details items interface.
  * @api
  */
 interface TaxDetailsItemInterface extends \Magento\Framework\Api\ExtensibleDataInterface
diff --git a/app/code/Magento/Tax/Api/Data/TaxRateInterface.php b/app/code/Magento/Tax/Api/Data/TaxRateInterface.php
@@ -8,6 +8,7 @@
 namespace Magento\Tax\Api\Data;
 
 /**
+ * Tax rate interface.
  * @api
  */
 interface TaxRateInterface extends \Magento\Framework\Api\ExtensibleDataInterface
diff --git a/app/code/Magento/Tax/Api/Data/TaxRateSearchResultsInterface.php b/app/code/Magento/Tax/Api/Data/TaxRateSearchResultsInterface.php
@@ -10,6 +10,7 @@
 use Magento\Framework\Api\SearchResultsInterface;
 
 /**
+ * Interface for tax rate search results.
  * @api
  */
 interface TaxRateSearchResultsInterface extends SearchResultsInterface
diff --git a/app/code/Magento/Tax/Api/Data/TaxRateTitleInterface.php b/app/code/Magento/Tax/Api/Data/TaxRateTitleInterface.php
@@ -8,6 +8,7 @@
 namespace Magento\Tax\Api\Data;
 
 /**
+ * Tax rate title interface.
  * @api
  */
 interface TaxRateTitleInterface extends \Magento\Framework\Api\ExtensibleDataInterface
diff --git a/app/code/Magento/Tax/Api/Data/TaxRuleInterface.php b/app/code/Magento/Tax/Api/Data/TaxRuleInterface.php
@@ -9,6 +9,7 @@
 use Magento\Framework\Api\ExtensibleDataInterface;
 
 /**
+ * Tax rule interface.
  * @api
  */
 interface TaxRuleInterface extends ExtensibleDataInterface
diff --git a/app/code/Magento/Tax/Api/Data/TaxRuleSearchResultsInterface.php b/app/code/Magento/Tax/Api/Data/TaxRuleSearchResultsInterface.php
@@ -7,6 +7,7 @@
 namespace Magento\Tax\Api\Data;
 
 /**
+ * Interface for tax rule search results.
  * @api
  */
 interface TaxRuleSearchResultsInterface extends \Magento\Framework\Api\SearchResultsInterface
diff --git a/app/code/Magento/Tax/Api/TaxCalculationInterface.php b/app/code/Magento/Tax/Api/TaxCalculationInterface.php
@@ -7,6 +7,7 @@
 namespace Magento\Tax\Api;
 
 /**
+ * Tax calculation interface.
  * @api
  */
 interface TaxCalculationInterface
diff --git a/app/code/Magento/Tax/Api/TaxClassManagementInterface.php b/app/code/Magento/Tax/Api/TaxClassManagementInterface.php
@@ -8,6 +8,7 @@
 namespace Magento\Tax\Api;
 
 /**
+ * Interface for managing classes rates.
  * @api
  */
 interface TaxClassManagementInterface
diff --git a/app/code/Magento/Tax/Api/TaxClassRepositoryInterface.php b/app/code/Magento/Tax/Api/TaxClassRepositoryInterface.php
@@ -8,6 +8,7 @@
 namespace Magento\Tax\Api;
 
 /**
+ * Tax class CRUD interface.
  * @api
  */
 interface TaxClassRepositoryInterface
diff --git a/app/code/Magento/Tax/Api/TaxRateManagementInterface.php b/app/code/Magento/Tax/Api/TaxRateManagementInterface.php
@@ -9,6 +9,7 @@
 use Magento\Tax\Api\Data\TaxRateInterface;
 
 /**
+ * Interface for managing tax rates.
  * @api
  */
 interface TaxRateManagementInterface
diff --git a/app/code/Magento/Tax/Api/TaxRateRepositoryInterface.php b/app/code/Magento/Tax/Api/TaxRateRepositoryInterface.php
@@ -8,6 +8,7 @@
 namespace Magento\Tax\Api;
 
 /**
+ * Tax rate CRUD interface.
  * @api
  */
 interface TaxRateRepositoryInterface
diff --git a/app/code/Magento/Tax/Api/TaxRuleRepositoryInterface.php b/app/code/Magento/Tax/Api/TaxRuleRepositoryInterface.php
@@ -7,6 +7,7 @@
 namespace Magento\Tax\Api;
 
 /**
+ * Tax rule CRUD interface.
  * @api
  */
 interface TaxRuleRepositoryInterface
