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

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

@@ -1,7 +1,7 @@
 <?php
 /**
- * Copyright © Magento, Inc. All rights reserved.
- * See COPYING.txt for license details.
+ * Copyright 2017 Adobe
+ * All Rights Reserved.
  */
 namespace Magento\Framework\Message;
 
@@ -21,7 +21,7 @@ class Manager implements ManagerInterface
     /**
      * Default message group
      */
-    const DEFAULT_GROUP = 'default';
+    public const DEFAULT_GROUP = 'default';
 
     /**
      * @var Session
@@ -88,7 +88,7 @@ public function __construct(
         $this->logger = $logger;
         $this->defaultGroup = $defaultGroup;
         $this->exceptionMessageFactory = $exceptionMessageFactory ?: ObjectManager::getInstance()
-            ->get(ExceptionMessageLookupFactory::class);
+            ->get(ExceptionMessageLookupFactory::class); // phpcs:ignore
     }
 
     /**
@@ -112,10 +112,6 @@ protected function prepareGroup($group)
 
     /**
      * @inheritdoc
-     *
-     * @param bool $clear
-     * @param string|null $group
-     * @return Collection
      */
     public function getMessages($clear = false, $group = null)
     {
@@ -135,10 +131,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 +142,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 +155,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 +164,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 +173,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 +182,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 +191,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 +207,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 +245,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 +272,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 +285,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 +298,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 +311,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 +324,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 +339,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 +354,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 +369,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 +384,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)
     {

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

@@ -1,7 +1,7 @@
 <?php
 /**
- * Copyright © Magento, Inc. All rights reserved.
- * See COPYING.txt for license details.
+ * Copyright 2017 Adobe
+ * All Rights Reserved.
  */
 namespace Magento\Framework\Message;
 
@@ -50,7 +50,7 @@ public function addMessages(array $messages, $group = null);
     /**
      * Adds new error message
      *
-     * @param string $message
+     * @param string|\Stringable $message
      * @param string|null $group
      * @return ManagerInterface
      * @deprecated 100.1.0
@@ -61,7 +61,7 @@ public function addError($message, $group = null);
     /**
      * Adds new warning message
      *
-     * @param string $message
+     * @param string|\Stringable $message
      * @param string|null $group
      * @return ManagerInterface
      * @deprecated 100.1.0
@@ -72,7 +72,7 @@ public function addWarning($message, $group = null);
     /**
      * Adds new notice message
      *
-     * @param string $message
+     * @param string|\Stringable $message
      * @param string|null $group
      * @return ManagerInterface
      * @deprecated 100.1.0
@@ -83,7 +83,7 @@ public function addNotice($message, $group = null);
     /**
      * Adds new success message
      *
-     * @param string $message
+     * @param string|\Stringable $message
      * @param string|null $group
      * @return ManagerInterface
      * @deprecated 100.1.0
@@ -94,7 +94,7 @@ public function addSuccess($message, $group = null);
     /**
      * Adds new error message
      *
-     * @param string $message
+     * @param string|\Stringable $message
      * @param string|null $group
      * @return ManagerInterface
      */
@@ -103,7 +103,7 @@ public function addErrorMessage($message, $group = null);
     /**
      * Adds new warning message
      *
-     * @param string $message
+     * @param string|\Stringable $message
      * @param string|null $group
      * @return ManagerInterface
      */
@@ -112,7 +112,7 @@ public function addWarningMessage($message, $group = null);
     /**
      * Adds new notice message
      *
-     * @param string $message
+     * @param string|\Stringable $message
      * @param string|null $group
      * @return ManagerInterface
      */
@@ -121,7 +121,7 @@ public function addNoticeMessage($message, $group = null);
     /**
      * Adds new success message
      *
-     * @param string $message
+     * @param string|\Stringable $message
      * @param string|null $group
      * @return ManagerInterface
      */
@@ -134,6 +134,7 @@ public function addSuccessMessage($message, $group = null);
      * @param array $data
      * @param string|null $group
      * @return ManagerInterface
+     * @throws \InvalidArgumentException
      */
     public function addComplexErrorMessage($identifier, array $data = [], $group = null);
 
@@ -144,6 +145,7 @@ public function addComplexErrorMessage($identifier, array $data = [], $group = n
      * @param array $data
      * @param string|null $group
      * @return ManagerInterface
+     * @throws \InvalidArgumentException
      */
     public function addComplexWarningMessage($identifier, array $data = [], $group = null);
 
@@ -154,6 +156,7 @@ public function addComplexWarningMessage($identifier, array $data = [], $group =
      * @param array $data
      * @param string|null $group
      * @return ManagerInterface
+     * @throws \InvalidArgumentException
      */
     public function addComplexNoticeMessage($identifier, array $data = [], $group = null);
 
@@ -164,6 +167,7 @@ public function addComplexNoticeMessage($identifier, array $data = [], $group =
      * @param array $data
      * @param string|null $group
      * @return ManagerInterface
+     * @throws \InvalidArgumentException
      */
     public function addComplexSuccessMessage($identifier, array $data = [], $group = null);
 
@@ -195,6 +199,7 @@ public function addException(\Exception $exception, $alternativeText = null, $gr
      * @param string|null $alternativeText
      * @param string|null $group
      * @return ManagerInterface
+     * @throws \InvalidArgumentException
      */
     public function addExceptionMessage(\Exception $exception, $alternativeText = null, $group = null);