Add descriptions to the phpdoc blocks, even if they are superfluous

Author: Vinai

app/code/Magento/Customer/Model/Plugin/CustomerNotification.php

@@ -72,7 +72,7 @@ public function __construct(
         $this->state = $state;
         $this->customerRepository = $customerRepository;
         $this->logger = $logger;
-        $this->request = $request ?? ObjectManager::getInstance()->get(RequestInterface::class);
+        $this->request = $request;
     }
 
     /**
@@ -100,14 +100,31 @@ public function beforeExecute(ActionInterface $subject)
         }
     }
 
+    /**
+     * Return the shared request.
+     * If the request wasn't injected because of the backward compatible optional constructor dependency,
+     * create a new request instance.
+     *
+     * @return RequestInterface
+     */
+    private function getRequest(): RequestInterface
+    {
+        if (null === $this->request) {
+            $this->request = ObjectManager::getInstance()->get(RequestInterface::class);
+        }
+        return $this->request;
+    }
+
     /**
      * Because RequestInterface has no isPost method the check is requied before calling it.
      *
      * @return bool
      */
     private function isPostRequest(): bool
     {
-        return method_exists($this->request, 'isPost') && $this->request->isPost();
+        $request = $this->getRequest();
+
+        return method_exists($request, 'isPost') && $request->isPost();
     }
 
     /**

app/code/Magento/Customer/Model/Visitor.php

@@ -317,6 +317,10 @@ public function getOnlineInterval()
     }
 
     /**
+     * Return the shared request.
+     * If the request wasn't injected because of the backward compatible optional constructor dependency,
+     * create a new request instance.
+     *
      * @return \Magento\Framework\App\RequestInterface|\Magento\Framework\App\Request\Http
      */
     private function getRequest()

dev/tests/integration/testsuite/Magento/Framework/App/TestStubs/InheritanceBasedBackendAction.php

@@ -5,6 +5,9 @@
 use Magento\Backend\App\Action;
 use Magento\Framework\View\Result\PageFactory;
 
+/**
+ * Stub inheritance based backend action controller for testing purposes.
+ */
 class InheritanceBasedBackendAction extends Action
 {
     /**

dev/tests/integration/testsuite/Magento/Framework/App/TestStubs/InheritanceBasedFrontendAction.php

@@ -6,6 +6,9 @@
 use Magento\Framework\App\Action\Context;
 use Magento\Framework\View\Result\PageFactory;
 
+/**
+ * Stub inheritance based frontend action controller for testing purposes.
+ */
 class InheritanceBasedFrontendAction extends Action
 {
     /**

dev/tests/integration/testsuite/Magento/Framework/App/TestStubs/InterfaceOnlyBackendAction.php

@@ -5,6 +5,9 @@
 use Magento\Framework\App\ActionInterface;
 use Magento\Framework\View\Result\PageFactory;
 
+/**
+ * Stub interface action controller implementation for testing purposes. 
+ */
 class InterfaceOnlyBackendAction implements ActionInterface
 {
     /**

dev/tests/integration/testsuite/Magento/Framework/App/TestStubs/InterfaceOnlyFrontendAction.php

@@ -5,6 +5,9 @@
 use Magento\Framework\App\ActionInterface;
 use Magento\Framework\View\Result\PageFactory;
 
+/**
+ * Stub interface only based frontend action controller for testing purposes.
+ */
 class InterfaceOnlyFrontendAction implements ActionInterface
 {
     /**

lib/internal/Magento/Framework/App/Action/Plugin/ActionFlagNoDispatchPlugin.php

@@ -7,7 +7,7 @@
 use Magento\Framework\App\ResponseInterface;
 
 /**
- *
+ * Do not call Action::execute() if the action flag FLAG_NO_DISPATCH is set.
  */
 class ActionFlagNoDispatchPlugin
 {
@@ -28,6 +28,8 @@ public function __construct(ActionFlag $actionFlag, ResponseInterface $response)
     }
 
     /**
+     * Do not call proceed if the no dispatch action flag is set.
+     *
      * @param ActionInterface $subject
      * @param callable $proceed
      * @return ResponseInterface

lib/internal/Magento/Framework/App/Action/Plugin/EventDispatchPlugin.php

@@ -12,7 +12,7 @@
 use Magento\Framework\HTTP\PhpEnvironment\Response;
 
 /**
- *
+ * Dispatch the controller_action_predispatch and controller_action_post_dispatch events.
  */
 class EventDispatchPlugin
 {
@@ -38,12 +38,19 @@ public function __construct(RequestInterface $request, ManagerInterface $eventMa
         $this->actionFlag = $actionFlag;
     }
 
+    /**
+     * Trigger the controller_action_predispatch events
+     *
+     * @param ActionInterface $subject
+     */
     public function beforeExecute(ActionInterface $subject)
     {
         $this->dispatchPreDispatchEvents($subject);
     }
 
     /**
+     * Build the event parameter array
+     *
      * @param ActionInterface $subject
      * @return mixed[]
      */
@@ -53,6 +60,8 @@ private function getEventParameters(ActionInterface $subject): array
     }
 
     /**
+     * Trigger the controller_action_postdispatch events if the suppressing action flag is not set
+     *
      * @param ActionInterface $subject
      * @param ResultInterface|Response|null $result
      * @return ResultInterface|Response|null
@@ -67,6 +76,8 @@ public function afterExecute(ActionInterface $subject, $result)
     }
 
     /**
+     * Check if action flags are set that would suppress the post dispatch events.
+     *
      * @param ActionInterface $subject
      * @return bool
      *
@@ -78,6 +89,8 @@ private function isSetActionNoPostDispatchFlag(): bool
     }
 
     /**
+     * Dispatch the controller_action_predispatch events.
+     *
      * @param ActionInterface $action
      */
     private function dispatchPreDispatchEvents(ActionInterface $action)
@@ -94,6 +107,8 @@ private function dispatchPreDispatchEvents(ActionInterface $action)
     }
 
     /**
+     * Dispatch the controller_action_postdispatch events.
+     *
      * @param ActionInterface $action
      */
     private function dispatchPostDispatchEvents(ActionInterface $action)