Merge pull request #1036 from magento-jackalopes/okopylova-api

MAGETWO-65670: Add @api Annotation in CmsUrlRewrite Module

Author: vrann

app/code/Magento/CatalogWidget/Model/Rule.php

@@ -9,7 +9,9 @@
 use Magento\Framework\Api\ExtensionAttributesFactory;
 
 /**
- * Class Rule
+ * Rule for catalog widget
+ *
+ * @api
  */
 class Rule extends \Magento\Rule\Model\AbstractModel
 {

app/code/Magento/CatalogWidget/Model/Rule/Condition/Combine.php

@@ -3,12 +3,11 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+namespace Magento\CatalogWidget\Model\Rule\Condition;
 
 /**
- * CatalogWidget Rule Combine Condition data model
+ * Combination of product conditions
  */
-namespace Magento\CatalogWidget\Model\Rule\Condition;
-
 class Combine extends \Magento\Rule\Model\Condition\Combine
 {
     /**
@@ -54,7 +53,7 @@ public function getNewChildSelectOptions()
         foreach ($productAttributes as $code => $label) {
             if (!in_array($code, $this->excludedAttributes)) {
                 $attributes[] = [
-                    'value' => 'Magento\CatalogWidget\Model\Rule\Condition\Product|' . $code,
+                    'value' => Product::class . '|' . $code,
                     'label' => $label,
                 ];
             }

app/code/Magento/Cms/Model/Wysiwyg/Config.php

@@ -11,6 +11,8 @@
 
 /**
  * Wysiwyg Config for Editor HTML Element
+ *
+ * @api
  */
 class Config extends \Magento\Framework\DataObject implements ConfigInterface
 {

app/code/Magento/Cms/Model/Wysiwyg/Images/Storage.php

@@ -14,6 +14,8 @@
  * @SuppressWarnings(PHPMD.LongVariable)
  * @SuppressWarnings(PHPMD.TooManyFields)
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
+ *
+ * @api
  */
 class Storage extends \Magento\Framework\DataObject
 {

app/code/Magento/Cms/Model/Wysiwyg/Images/Storage/Collection.php

@@ -12,6 +12,8 @@
 
 /**
  * Wysiwyg Images storage collection
+ *
+ * @api
  */
 class Collection extends \Magento\Framework\Data\Collection\Filesystem
 {

app/code/Magento/CmsUrlRewrite/Model/CmsPageUrlPathGenerator.php

@@ -7,6 +7,9 @@
 
 use Magento\Cms\Api\Data\PageInterface;
 
+/**
+ * @api
+ */
 class CmsPageUrlPathGenerator
 {
     /** @var \Magento\Framework\Filter\FilterManager */
@@ -22,7 +25,6 @@ public function __construct(
      * @param PageInterface $cmsPage
      *
      * @return string
-     * @api
      */
     public function getUrlPath(PageInterface $cmsPage)
     {
@@ -34,7 +36,6 @@ public function getUrlPath(PageInterface $cmsPage)
      *
      * @param PageInterface $cmsPage
      * @return string
-     * @api
      */
     public function getCanonicalUrlPath(PageInterface $cmsPage)
     {
@@ -46,7 +47,6 @@ public function getCanonicalUrlPath(PageInterface $cmsPage)
      *
      * @param PageInterface $cmsPage
      * @return string
-     * @api
      */
     public function generateUrlKey(PageInterface $cmsPage)
     {

app/code/Magento/CmsUrlRewrite/README.md

@@ -0,0 +1,6 @@
+## Overview
+ 
+The Magento_CmsUrlRewrite module adds support for URL rewrite rules for CMS pages. See also Magento_UrlRewrite module. 
+
+The module adds and removes URL rewrite rules as CMS pages are added or removed by a user.
+The rules can be edited by an admin user as any other URL rewrite rule. 

app/code/Magento/Cron/Model/ConfigInterface.php

@@ -7,6 +7,8 @@
 
 /**
  * Interface \Magento\Cron\Model\ConfigInterface
+ *
+ * @api
  */
 interface ConfigInterface
 {

app/code/Magento/Cron/Model/ResourceModel/Schedule.php

@@ -8,7 +8,7 @@
 /**
  * Schedule resource
  *
- * @author      Magento Core Team <core@magentocommerce.com>
+ * @api
  */
 class Schedule extends \Magento\Framework\Model\ResourceModel\Db\AbstractDb
 {

app/code/Magento/Cron/Model/ResourceModel/Schedule/Collection.php

@@ -8,7 +8,7 @@
 /**
  * Schedules Collection
  *
- * @author      Magento Core Team <core@magentocommerce.com>
+ * @api
  */
 class Collection extends \Magento\Framework\Model\ResourceModel\Db\Collection\AbstractCollection
 {