Merge pull request #315 from magento-tango/MAGETWO-36095

[Tango] API

Author: Kovsher, Iurii(ikovsher)

app/code/Magento/Captcha/Block/Captcha/DefaultCaptcha.php

@@ -79,7 +79,7 @@ protected function _toHtml()
     /**
      * Returns captcha model
      *
-     * @return \Magento\Captcha\Model\ModelInterface
+     * @return \Magento\Captcha\Model\CaptchaInterface
      */
     public function getCaptchaModel()
     {

app/code/Magento/Captcha/Helper/Data.php

@@ -81,7 +81,7 @@ public function __construct(
      * Get Captcha
      *
      * @param string $formId
-     * @return \Magento\Captcha\Model\ModelInterface
+     * @return \Magento\Captcha\Model\CaptchaInterface
      */
     public function getCaptcha($formId)
     {

app/code/Magento/Captcha/Model/CaptchaFactory.php

@@ -27,17 +27,17 @@ public function __construct(\Magento\Framework\ObjectManagerInterface $objectMan
      *
      * @param string $captchaType
      * @param string $formId
-     * @return \Magento\Captcha\Model\ModelInterface
+     * @return \Magento\Captcha\Model\CaptchaInterface
      * @throws \InvalidArgumentException
      */
     public function create($captchaType, $formId)
     {
         $className = 'Magento\Captcha\Model\\' . ucfirst($captchaType);
 
         $instance = $this->_objectManager->create($className, ['formId' => $formId]);
-        if (!$instance instanceof \Magento\Captcha\Model\ModelInterface) {
+        if (!$instance instanceof \Magento\Captcha\Model\CaptchaInterface) {
             throw new \InvalidArgumentException(
-                $className . ' does not implement \Magento\Captcha\Model\ModelInterface'
+                $className . ' does not implement \Magento\Captcha\Model\CaptchaInterface'
             );
         }
         return $instance;

app/code/Magento/Captcha/Model/ModelInterface.php renamed to app/code/Magento/Captcha/Model/CaptchaInterface.php

@@ -7,7 +7,12 @@
  */
 namespace Magento\Captcha\Model;
 
-interface ModelInterface
+/**
+ * Captcha Model Interface
+ *
+ * @api
+ */
+interface CaptchaInterface
 {
     /**
      * Generates captcha

app/code/Magento/Captcha/Model/Checkout/ConfigProvider.php

@@ -119,7 +119,7 @@ protected function isRequired($formId)
      * Return captcha model for specified form
      *
      * @param string $formId
-     * @return \Magento\Captcha\Model\ModelInterface
+     * @return \Magento\Captcha\Model\CaptchaInterface
      */
     protected function getCaptchaModel($formId)
     {

app/code/Magento/Captcha/Model/DefaultModel.php

@@ -10,7 +10,7 @@
  *
  * @author     Magento Core Team <core@magentocommerce.com>
  */
-class DefaultModel extends \Zend_Captcha_Image implements \Magento\Captcha\Model\ModelInterface
+class DefaultModel extends \Zend_Captcha_Image implements \Magento\Captcha\Model\CaptchaInterface
 {
     /**
      * Key in session for captcha code

app/code/Magento/Captcha/Test/Unit/Model/CaptchaFactoryTest.php

@@ -58,7 +58,7 @@ public function testCreateNegative()
             'InvalidArgumentException',
             'Magento\Captcha\Model\\' . ucfirst(
                 $captchaType
-            ) . ' does not implement \Magento\Captcha\Model\ModelInterface'
+            ) . ' does not implement \Magento\Captcha\Model\CaptchaInterface'
         );
 
         $this->assertEquals($defaultCaptchaMock, $this->_model->create($captchaType, 'form_id'));

app/code/Magento/Widget/Model/Widget.php

@@ -6,13 +6,11 @@
 
 // @codingStandardsIgnoreFile
 
+namespace Magento\Widget\Model;
+
 /**
  * Widget model for different purposes
- *
- * @author      Magento Core Team <core@magentocommerce.com>
  */
-namespace Magento\Widget\Model;
-
 class Widget
 {
     /**
@@ -86,6 +84,7 @@ public function __construct(
      *
      * @param string $type Widget type
      * @return null|array
+     * @api
      */
     public function getWidgetByClassType($type)
     {
@@ -185,6 +184,7 @@ public function getConfigAsObject($type)
      *
      * @param array $filters Key-value array of filters for widget node properties
      * @return array
+     * @api
      */
     public function getWidgets($filters = [])
     {
@@ -215,6 +215,7 @@ public function getWidgets($filters = [])
      *
      * @param array $filters Key-value array of filters for widget node properties
      * @return array
+     * @api
      */
     public function getWidgetsArray($filters = [])
     {
@@ -241,6 +242,7 @@ public function getWidgetsArray($filters = [])
      * @param array $params Pre-configured Widget Params
      * @param bool $asIs Return result as widget directive(true) or as placeholder image(false)
      * @return string Widget directive ready to parse
+     * @api
      */
     public function getWidgetDeclaration($type, $params = [], $asIs = true)
     {