Merge pull request #1378 from magento-engcom/MAGETWO-71174

MAGETWO-71174: Update doc block information in php classes with @deprecated and @SInCE tags
magento · Aug 2, 2017 · e2f7eec · e2f7eec
2 parents 9badb94 + a9fcfa9
commit e2f7eec
Show file tree

Hide file tree

Showing 8,251 changed files with 2,278 additions and 62,895 deletions.
diff --git a/app/code/Magento/AdminNotification/Block/Grid/Renderer/Actions.php b/app/code/Magento/AdminNotification/Block/Grid/Renderer/Actions.php
@@ -11,21 +11,18 @@
 /**
  * Class \Magento\AdminNotification\Block\Grid\Renderer\Actions
  *
- * @since 2.0.0
  */
 class Actions extends \Magento\Backend\Block\Widget\Grid\Column\Renderer\AbstractRenderer
 {
     /**
      * @var \Magento\Framework\Url\Helper\Data
-     * @since 2.0.0
      */
     protected $_urlHelper;
 
     /**
      * @param \Magento\Backend\Block\Context $context
      * @param \Magento\Framework\Url\Helper\Data $urlHelper
      * @param array $data
-     * @since 2.0.0
      */
     public function __construct(
         \Magento\Backend\Block\Context $context,
@@ -41,7 +38,6 @@ public function __construct(
      *
      * @param   \Magento\Framework\DataObject $row
      * @return  string
-     * @since 2.0.0
      */
     public function render(\Magento\Framework\DataObject $row)
     {

diff --git a/app/code/Magento/AdminNotification/Block/Grid/Renderer/Notice.php b/app/code/Magento/AdminNotification/Block/Grid/Renderer/Notice.php
@@ -10,7 +10,6 @@
 /**
  * Class \Magento\AdminNotification\Block\Grid\Renderer\Notice
  *
- * @since 2.0.0
  */
 class Notice extends \Magento\Backend\Block\Widget\Grid\Column\Renderer\AbstractRenderer
 {
@@ -19,7 +18,6 @@ class Notice extends \Magento\Backend\Block\Widget\Grid\Column\Renderer\Abstract
      *
      * @param   \Magento\Framework\DataObject $row
      * @return  string
-     * @since 2.0.0
      */
     public function render(\Magento\Framework\DataObject $row)
     {

diff --git a/app/code/Magento/AdminNotification/Block/Grid/Renderer/Severity.php b/app/code/Magento/AdminNotification/Block/Grid/Renderer/Severity.php
@@ -12,21 +12,18 @@
 /**
  * Class \Magento\AdminNotification\Block\Grid\Renderer\Severity
  *
- * @since 2.0.0
  */
 class Severity extends \Magento\Backend\Block\Widget\Grid\Column\Renderer\AbstractRenderer
 {
     /**
      * @var \Magento\AdminNotification\Model\Inbox
-     * @since 2.0.0
      */
     protected $_notice;
 
     /**
      * @param \Magento\Backend\Block\Context $context
      * @param \Magento\AdminNotification\Model\Inbox $notice
      * @param array $data
-     * @since 2.0.0
      */
     public function __construct(
         \Magento\Backend\Block\Context $context,
@@ -42,7 +39,6 @@ public function __construct(
      *
      * @param   \Magento\Framework\DataObject $row
      * @return  string
-     * @since 2.0.0
      */
     public function render(\Magento\Framework\DataObject $row)
     {

diff --git a/app/code/Magento/AdminNotification/Block/Inbox.php b/app/code/Magento/AdminNotification/Block/Inbox.php
@@ -9,13 +9,11 @@
 
 /**
  * @api
- * @since 2.0.0
  */
 class Inbox extends \Magento\Backend\Block\Widget\Grid\Container
 {
     /**
      * @return void
-     * @since 2.0.0
      */
     protected function _construct()
     {

diff --git a/app/code/Magento/AdminNotification/Block/System/Messages.php b/app/code/Magento/AdminNotification/Block/System/Messages.php
@@ -8,21 +8,18 @@
 /**
  * Class \Magento\AdminNotification\Block\System\Messages
  *
- * @since 2.0.0
  */
 class Messages extends \Magento\Backend\Block\Template
 {
     /**
      * Message list
      *
      * @var \Magento\AdminNotification\Model\ResourceModel\System\Message\Collection\Synchronized
-     * @since 2.0.0
      */
     protected $_messages;
 
     /**
      * @var \Magento\Framework\Json\Helper\Data
-     * @since 2.0.0
      */
     protected $jsonHelper;
 
@@ -31,7 +28,6 @@ class Messages extends \Magento\Backend\Block\Template
      * @param \Magento\AdminNotification\Model\ResourceModel\System\Message\Collection\Synchronized $messages
      * @param \Magento\Framework\Json\Helper\Data $jsonHelper
      * @param array $data
-     * @since 2.0.0
      */
     public function __construct(
         \Magento\Backend\Block\Template\Context $context,
@@ -48,7 +44,6 @@ public function __construct(
      * Prepare html output
      *
      * @return string
-     * @since 2.0.0
      */
     protected function _toHtml()
     {
@@ -62,7 +57,6 @@ protected function _toHtml()
      * Retrieve message list
      *
      * @return \Magento\Framework\Notification\MessageInterface[]
-     * @since 2.0.0
      */
     public function getLastCritical()
     {
@@ -80,7 +74,6 @@ public function getLastCritical()
      * Retrieve number of critical messages
      *
      * @return int
-     * @since 2.0.0
      */
     public function getCriticalCount()
     {
@@ -93,7 +86,6 @@ public function getCriticalCount()
      * Retrieve number of major messages
      *
      * @return int
-     * @since 2.0.0
      */
     public function getMajorCount()
     {
@@ -106,7 +98,6 @@ public function getMajorCount()
      * Check whether system messages are present
      *
      * @return bool
-     * @since 2.0.0
      */
     public function hasMessages()
     {
@@ -117,7 +108,6 @@ public function hasMessages()
      * Retrieve message list url
      *
      * @return string
-     * @since 2.0.0
      */
     protected function _getMessagesUrl()
     {
@@ -128,7 +118,6 @@ protected function _getMessagesUrl()
      * Initialize system message dialog widget
      *
      * @return string
-     * @since 2.0.0
      */
     public function getSystemMessageDialogJson()
     {

diff --git a/app/code/Magento/AdminNotification/Block/System/Messages/UnreadMessagePopup.php b/app/code/Magento/AdminNotification/Block/System/Messages/UnreadMessagePopup.php
@@ -9,15 +9,13 @@
 
 /**
  * @api
- * @since 2.0.0
  */
 class UnreadMessagePopup extends \Magento\Backend\Block\Template
 {
     /**
      * List of item classes per severity
      *
      * @var array
-     * @since 2.0.0
      */
     protected $_itemClasses = [
         MessageInterface::SEVERITY_CRITICAL => 'error',
@@ -28,15 +26,13 @@ class UnreadMessagePopup extends \Magento\Backend\Block\Template
      * System Message list
      *
      * @var \Magento\AdminNotification\Model\ResourceModel\System\Message\Collection
-     * @since 2.0.0
      */
     protected $_messages;
 
     /**
      * @param \Magento\Backend\Block\Template\Context $context
      * @param \Magento\AdminNotification\Model\ResourceModel\System\Message\Collection\Synchronized $messages
      * @param array $data
-     * @since 2.0.0
      */
     public function __construct(
         \Magento\Backend\Block\Template\Context $context,
@@ -51,7 +47,6 @@ public function __construct(
      * Render block
      *
      * @return string
-     * @since 2.0.0
      */
     protected function _toHtml()
     {
@@ -65,7 +60,6 @@ protected function _toHtml()
      * Retrieve list of unread messages
      *
      * @return MessageInterface[]
-     * @since 2.0.0
      */
     public function getUnreadMessages()
     {
@@ -76,7 +70,6 @@ public function getUnreadMessages()
      * Retrieve popup title
      *
      * @return \Magento\Framework\Phrase
-     * @since 2.0.0
      */
     public function getPopupTitle()
     {
@@ -93,7 +86,6 @@ public function getPopupTitle()
      *
      * @param MessageInterface $message
      * @return string
-     * @since 2.0.0
      */
     public function getItemClass(MessageInterface $message)
     {

diff --git a/app/code/Magento/AdminNotification/Block/ToolbarEntry.php b/app/code/Magento/AdminNotification/Block/ToolbarEntry.php
@@ -11,7 +11,6 @@
  *
  * @api
  * @author      Magento Core Team <[email protected]>
- * @since 2.0.0
  */
 class ToolbarEntry extends \Magento\Backend\Block\Template
 {
@@ -34,15 +33,13 @@ class ToolbarEntry extends \Magento\Backend\Block\Template
      * Collection of latest unread notifications
      *
      * @var \Magento\AdminNotification\Model\ResourceModel\Inbox\Collection
-     * @since 2.0.0
      */
     protected $_notificationList;
 
     /**
      * @param \Magento\Backend\Block\Template\Context $context
      * @param \Magento\AdminNotification\Model\ResourceModel\Inbox\Collection\Unread $notificationList
      * @param array $data
-     * @since 2.0.0
      */
     public function __construct(
         \Magento\Backend\Block\Template\Context $context,
@@ -57,7 +54,6 @@ public function __construct(
      * Retrieve notification description start length
      *
      * @return int
-     * @since 2.0.0
      */
     public function getNotificationDescriptionLength()
     {
@@ -68,7 +64,6 @@ public function getNotificationDescriptionLength()
      * Retrieve notification counter max value
      *
      * @return int
-     * @since 2.0.0
      */
     public function getNotificationCounterMax()
     {
@@ -79,7 +74,6 @@ public function getNotificationCounterMax()
      * Retrieve number of unread notifications
      *
      * @return int
-     * @since 2.0.0
      */
     public function getUnreadNotificationCount()
     {
@@ -90,7 +84,6 @@ public function getUnreadNotificationCount()
      * Retrieve the list of latest unread notifications
      *
      * @return \Magento\AdminNotification\Model\ResourceModel\Inbox\Collection
-     * @since 2.0.0
      */
     public function getLatestUnreadNotifications()
     {
@@ -102,7 +95,6 @@ public function getLatestUnreadNotifications()
      *
      * @param string $dateString
      * @return string
-     * @since 2.0.0
      */
     public function formatNotificationDate($dateString)
     {

diff --git a/app/code/Magento/AdminNotification/Block/Window.php b/app/code/Magento/AdminNotification/Block/Window.php
@@ -9,7 +9,6 @@
 
 /**
  * @api
- * @since 2.0.0
  */
 class Window extends \Magento\Backend\Block\Template
 {
@@ -22,29 +21,25 @@ class Window extends \Magento\Backend\Block\Template
      * Severity icons url
      *
      * @var string
-     * @since 2.0.0
      */
     protected $_severityIconsUrl;
 
     /**
      * Authentication
      *
      * @var \Magento\Backend\Model\Auth\Session
-     * @since 2.0.0
      */
     protected $_authSession;
 
     /**
      * Critical messages collection
      *
      * @var \Magento\AdminNotification\Model\ResourceModel\Inbox\Collection
-     * @since 2.0.0
      */
     protected $_criticalCollection;
 
     /**
      * @var \Magento\Adminnotification\Model\Inbox
-     * @since 2.0.0
      */
     protected $_latestItem;
 
@@ -53,7 +48,6 @@ class Window extends \Magento\Backend\Block\Template
      * If it isn't defined then application considers it as false.
      *
      * @var bool
-     * @since 2.0.0
      */
     protected $_isScopePrivate;
 
@@ -62,7 +56,6 @@ class Window extends \Magento\Backend\Block\Template
      * @param \Magento\Backend\Model\Auth\Session $authSession
      * @param \Magento\AdminNotification\Model\ResourceModel\Inbox\Collection\Critical $criticalCollection
      * @param array $data
-     * @since 2.0.0
      */
     public function __construct(
         \Magento\Backend\Block\Template\Context $context,
@@ -80,7 +73,6 @@ public function __construct(
      * Render block
      *
      * @return string
-     * @since 2.0.0
      */
     protected function _toHtml()
     {
@@ -100,7 +92,6 @@ protected function _toHtml()
      * Retrieve latest critical item
      *
      * @return bool|\Magento\Adminnotification\Model\Inbox
-     * @since 2.0.0
      */
     protected function _getLatestItem()
     {
@@ -119,7 +110,6 @@ protected function _getLatestItem()
      * Check whether block should be displayed
      *
      * @return bool
-     * @since 2.0.0
      */
     public function canShow()
     {

diff --git a/app/code/Magento/AdminNotification/Controller/Adminhtml/Notification.php b/app/code/Magento/AdminNotification/Controller/Adminhtml/Notification.php
@@ -9,7 +9,6 @@
 
 /**
  * @api
- * @since 2.0.0
  */
 abstract class Notification extends \Magento\Backend\App\AbstractAction
 {