[PHPDOC] Fix bad phpdoc for Magento\Framework\Message\ManagerInterface

lib/internal/Magento/Framework/Message/Manager.php

@@ -1,14 +1,15 @@
 <?php
 /**
- * Copyright © Magento, Inc. All rights reserved.
- * See COPYING.txt for license details.
+ * Copyright 2017 Adobe
+ * All Rights Reserved.
  */
 namespace Magento\Framework\Message;
 
 use Magento\Framework\Event;
 use Psr\Log\LoggerInterface;
 use Magento\Framework\App\ObjectManager;
 use Magento\Framework\Debug;
+use Magento\Framework\Message\ExceptionMessageLookupFactory;
 
 /**
  * Message manager model
@@ -21,7 +22,7 @@ class Manager implements ManagerInterface
     /**
      * Default message group
      */
-    const DEFAULT_GROUP = 'default';
+    public const DEFAULT_GROUP = 'default';
 
     /**
      * @var Session
@@ -63,6 +64,10 @@ class Manager implements ManagerInterface
      */
     private $exceptionMessageFactory;
 
+    /**
+     * @var ExceptionMessageLookupFactory
+     */
+    private $exceptionMessageLookupFactory;
     /**
      * @param Session $session
      * @param Factory $messageFactory
@@ -71,6 +76,7 @@ class Manager implements ManagerInterface
      * @param LoggerInterface $logger
      * @param string $defaultGroup
      * @param ExceptionMessageFactoryInterface|null $exceptionMessageFactory
+     * @param ExceptionMessageLookupFactory|null $exceptionMessageLookupFactory
      */
     public function __construct(
         Session $session,
@@ -79,16 +85,18 @@ public function __construct(
         Event\ManagerInterface $eventManager,
         LoggerInterface $logger,
         $defaultGroup = self::DEFAULT_GROUP,
-        ExceptionMessageFactoryInterface $exceptionMessageFactory = null
+        ExceptionMessageFactoryInterface $exceptionMessageFactory = null,
+        ExceptionMessageLookupFactory $exceptionMessageLookupFactory = null
     ) {
         $this->session = $session;
         $this->messageFactory = $messageFactory;
         $this->messagesFactory = $messagesFactory;
         $this->eventManager = $eventManager;
         $this->logger = $logger;
         $this->defaultGroup = $defaultGroup;
-        $this->exceptionMessageFactory = $exceptionMessageFactory ?: ObjectManager::getInstance()
-            ->get(ExceptionMessageLookupFactory::class);
+        $this->exceptionMessageFactory = $exceptionMessageFactory ?:
+            ($this->exceptionMessageLookupFactory = $exceptionMessageLookupFactory ?:
+                ObjectManager::getInstance()->get(ExceptionMessageLookupFactory::class));
     }
 
     /**
@@ -112,10 +120,6 @@ protected function prepareGroup($group)
 
     /**
      * @inheritdoc
-     *
-     * @param bool $clear
-     * @param string|null $group
-     * @return Collection
      */
     public function getMessages($clear = false, $group = null)
     {
@@ -135,10 +139,6 @@ public function getMessages($clear = false, $group = null)
 
     /**
      * @inheritdoc
-     *
-     * @param MessageInterface $message
-     * @param string|null $group
-     * @return $this
      */
     public function addMessage(MessageInterface $message, $group = null)
     {
@@ -150,10 +150,6 @@ public function addMessage(MessageInterface $message, $group = null)
 
     /**
      * @inheritdoc
-     *
-     * @param MessageInterface[] $messages
-     * @param string|null $group
-     * @return $this
      */
     public function addMessages(array $messages, $group = null)
     {
@@ -167,10 +163,6 @@ public function addMessages(array $messages, $group = null)
 
     /**
      * @inheritdoc
-     *
-     * @param string $message
-     * @param string|null $group
-     * @return $this
      */
     public function addError($message, $group = null)
     {
@@ -180,10 +172,6 @@ public function addError($message, $group = null)
 
     /**
      * @inheritdoc
-     *
-     * @param string $message
-     * @param string|null $group
-     * @return $this
      */
     public function addWarning($message, $group = null)
     {
@@ -193,10 +181,6 @@ public function addWarning($message, $group = null)
 
     /**
      * @inheritdoc
-     *
-     * @param string $message
-     * @param string|null $group
-     * @return $this
      */
     public function addNotice($message, $group = null)
     {
@@ -206,10 +190,6 @@ public function addNotice($message, $group = null)
 
     /**
      * @inheritdoc
-     *
-     * @param string $message
-     * @param string|null $group
-     * @return $this
      */
     public function addSuccess($message, $group = null)
     {
@@ -219,10 +199,6 @@ public function addSuccess($message, $group = null)
 
     /**
      * @inheritdoc
-     *
-     * @param MessageInterface[] $messages
-     * @param string|null $group
-     * @return $this
      */
     public function addUniqueMessages(array $messages, $group = null)
     {
@@ -239,11 +215,6 @@ public function addUniqueMessages(array $messages, $group = null)
 
     /**
      * @inheritdoc
-     *
-     * @param \Exception $exception
-     * @param string $alternativeText
-     * @param string $group
-     * @return $this
      */
     public function addException(\Exception $exception, $alternativeText = null, $group = null)
     {
@@ -282,11 +253,6 @@ public function hasMessages()
 
     /**
      * @inheritdoc
-     *
-     * @param \Exception $exception
-     * @param string $alternativeText
-     * @param string $group
-     * @return $this
      */
     public function addExceptionMessage(\Exception $exception, $alternativeText = null, $group = null)
     {
@@ -314,11 +280,7 @@ public function addExceptionMessage(\Exception $exception, $alternativeText = nu
     }
 
     /**
-     * Adds new error message
-     *
-     * @param string $message
-     * @param string|null $group
-     * @return ManagerInterface
+     * @inheritdoc
      */
     public function addErrorMessage($message, $group = null)
     {
@@ -331,11 +293,7 @@ public function addErrorMessage($message, $group = null)
     }
 
     /**
-     * Adds new warning message
-     *
-     * @param string $message
-     * @param string|null $group
-     * @return ManagerInterface
+     * @inheritdoc
      */
     public function addWarningMessage($message, $group = null)
     {
@@ -348,11 +306,7 @@ public function addWarningMessage($message, $group = null)
     }
 
     /**
-     * Adds new notice message
-     *
-     * @param string $message
-     * @param string|null $group
-     * @return ManagerInterface
+     * @inheritdoc
      */
     public function addNoticeMessage($message, $group = null)
     {
@@ -365,11 +319,7 @@ public function addNoticeMessage($message, $group = null)
     }
 
     /**
-     * Adds new success message
-     *
-     * @param string $message
-     * @param string|null $group
-     * @return ManagerInterface
+     * @inheritdoc
      */
     public function addSuccessMessage($message, $group = null)
     {
@@ -382,13 +332,7 @@ public function addSuccessMessage($message, $group = null)
     }
 
     /**
-     * Adds new complex error message
-     *
-     * @param string $identifier
-     * @param array $data
-     * @param string|null $group
-     * @return ManagerInterface
-     * @throws \InvalidArgumentException
+     * @inheritdoc
      */
     public function addComplexErrorMessage($identifier, array $data = [], $group = null)
     {
@@ -403,13 +347,7 @@ public function addComplexErrorMessage($identifier, array $data = [], $group = n
     }
 
     /**
-     * Adds new complex warning message
-     *
-     * @param string $identifier
-     * @param array $data
-     * @param string|null $group
-     * @return ManagerInterface
-     * @throws \InvalidArgumentException
+     * @inheritdoc
      */
     public function addComplexWarningMessage($identifier, array $data = [], $group = null)
     {
@@ -424,13 +362,7 @@ public function addComplexWarningMessage($identifier, array $data = [], $group =
     }
 
     /**
-     * Adds new complex notice message
-     *
-     * @param string $identifier
-     * @param array $data
-     * @param string|null $group
-     * @return ManagerInterface
-     * @throws \InvalidArgumentException
+     * @inheritdoc
      */
     public function addComplexNoticeMessage($identifier, array $data = [], $group = null)
     {
@@ -445,13 +377,7 @@ public function addComplexNoticeMessage($identifier, array $data = [], $group =
     }
 
     /**
-     * Adds new complex success message
-     *
-     * @param string $identifier
-     * @param array $data
-     * @param string|null $group
-     * @return ManagerInterface
-     * @throws \InvalidArgumentException
+     * @inheritdoc
      */
     public function addComplexSuccessMessage($identifier, array $data = [], $group = null)
     {
@@ -466,12 +392,7 @@ public function addComplexSuccessMessage($identifier, array $data = [], $group =
     }
 
     /**
-     * Creates identified message
-     *
-     * @param string $type
-     * @param string|null $identifier
-     * @return MessageInterface
-     * @throws \InvalidArgumentException
+     * @inheritdoc
      */
     public function createMessage($type, $identifier = null)
     {