Cleanup @return annotations

Author: nicolas-grekas

EventListener/AbstractSessionListener.php

@@ -191,7 +191,7 @@ public static function getSubscribedEvents(): array
     /**
      * Gets the session object.
      *
-     * @return SessionInterface|null A SessionInterface instance or null if no session is available
+     * @return SessionInterface|null
      */
     abstract protected function getSession();
 }

EventListener/AbstractTestSessionListener.php

@@ -112,7 +112,7 @@ public static function getSubscribedEvents(): array
      *
      * @deprecated since Symfony 5.4, will be removed in 6.0.
      *
-     * @return SessionInterface|null A SessionInterface instance or null if no session is available
+     * @return SessionInterface|null
      */
     abstract protected function getSession();
 }

Fragment/FragmentRendererInterface.php

@@ -27,7 +27,7 @@ interface FragmentRendererInterface
      *
      * @param string|ControllerReference $uri A URI as a string or a ControllerReference instance
      *
-     * @return Response A Response instance
+     * @return Response
      */
     public function render($uri, Request $request, array $options = []);
 

HttpCache/AbstractSurrogate.php

@@ -41,7 +41,7 @@ public function __construct(array $contentTypes = ['text/html', 'text/xml', 'app
     /**
      * Returns a new cache strategy instance.
      *
-     * @return ResponseCacheStrategyInterface A ResponseCacheStrategyInterface instance
+     * @return ResponseCacheStrategyInterface
      */
     public function createCacheStrategy()
     {

HttpCache/HttpCache.php

@@ -106,7 +106,7 @@ public function __construct(HttpKernelInterface $kernel, StoreInterface $store,
     /**
      * Gets the current store.
      *
-     * @return StoreInterface A StoreInterface instance
+     * @return StoreInterface
      */
     public function getStore()
     {
@@ -158,7 +158,7 @@ public function getLog()
     /**
      * Gets the Request instance associated with the main request.
      *
-     * @return Request A Request instance
+     * @return Request
      */
     public function getRequest()
     {
@@ -168,7 +168,7 @@ public function getRequest()
     /**
      * Gets the Kernel instance.
      *
-     * @return HttpKernelInterface An HttpKernelInterface instance
+     * @return HttpKernelInterface
      */
     public function getKernel()
     {
@@ -178,7 +178,7 @@ public function getKernel()
     /**
      * Gets the Surrogate instance.
      *
-     * @return SurrogateInterface A Surrogate instance
+     * @return SurrogateInterface
      *
      * @throws \LogicException
      */
@@ -258,7 +258,7 @@ public function terminate(Request $request, Response $response)
      *
      * @param bool $catch Whether to process exceptions
      *
-     * @return Response A Response instance
+     * @return Response
      */
     protected function pass(Request $request, bool $catch = false)
     {
@@ -272,7 +272,7 @@ protected function pass(Request $request, bool $catch = false)
      *
      * @param bool $catch Whether to process exceptions
      *
-     * @return Response A Response instance
+     * @return Response
      *
      * @throws \Exception
      *
@@ -320,7 +320,7 @@ protected function invalidate(Request $request, bool $catch = false)
      *
      * @param bool $catch Whether to process exceptions
      *
-     * @return Response A Response instance
+     * @return Response
      *
      * @throws \Exception
      */
@@ -369,7 +369,7 @@ protected function lookup(Request $request, bool $catch = false)
      *
      * @param bool $catch Whether to process exceptions
      *
-     * @return Response A Response instance
+     * @return Response
      */
     protected function validate(Request $request, Response $entry, bool $catch = false)
     {
@@ -432,7 +432,7 @@ protected function validate(Request $request, Response $entry, bool $catch = fal
      *
      * @param bool $catch Whether to process exceptions
      *
-     * @return Response A Response instance
+     * @return Response
      */
     protected function fetch(Request $request, bool $catch = false)
     {
@@ -465,7 +465,7 @@ protected function fetch(Request $request, bool $catch = false)
      * @param bool          $catch Whether to catch exceptions or not
      * @param Response|null $entry A Response instance (the stale entry if present, null otherwise)
      *
-     * @return Response A Response instance
+     * @return Response
      */
     protected function forward(Request $request, bool $catch = false, Response $entry = null)
     {

HttpCache/Store.php

@@ -125,7 +125,7 @@ public function isLocked(Request $request)
     /**
      * Locates a cached Response for the Request provided.
      *
-     * @return Response|null A Response instance, or null if no cache entry was found
+     * @return Response|null
      */
     public function lookup(Request $request)
     {

HttpCache/StoreInterface.php

@@ -27,7 +27,7 @@ interface StoreInterface
     /**
      * Locates a cached Response for the Request provided.
      *
-     * @return Response|null A Response instance, or null if no cache entry was found
+     * @return Response|null
      */
     public function lookup(Request $request);
 

HttpCache/SurrogateInterface.php

@@ -26,7 +26,7 @@ public function getName();
     /**
      * Returns a new cache strategy instance.
      *
-     * @return ResponseCacheStrategyInterface A ResponseCacheStrategyInterface instance
+     * @return ResponseCacheStrategyInterface
      */
     public function createCacheStrategy();
 

HttpKernelBrowser.php

@@ -58,7 +58,7 @@ public function catchExceptions(bool $catchExceptions)
      *
      * @param Request $request
      *
-     * @return Response A Response instance
+     * @return Response
      */
     protected function doRequest(object $request)
     {
@@ -130,7 +130,7 @@ protected function getHandleScript()
     /**
      * {@inheritdoc}
      *
-     * @return Request A Request instance
+     * @return Request
      */
     protected function filterRequest(DomRequest $request)
     {
@@ -194,7 +194,7 @@ protected function filterFiles(array $files)
      *
      * @param Request $request
      *
-     * @return DomResponse A DomResponse instance
+     * @return DomResponse
      */
     protected function filterResponse(object $response)
     {

HttpKernelInterface.php

@@ -40,7 +40,7 @@ interface HttpKernelInterface
      *                    (one of HttpKernelInterface::MAIN_REQUEST or HttpKernelInterface::SUB_REQUEST)
      * @param bool $catch Whether to catch exceptions or not
      *
-     * @return Response A Response instance
+     * @return Response
      *
      * @throws \Exception When an Exception occurs during processing
      */