Cleanup @return annotations

Author: nicolas-grekas

Generator/Dumper/GeneratorDumperInterface.php

@@ -31,7 +31,7 @@ public function dump(array $options = []);
     /**
      * Gets the routes to dump.
      *
-     * @return RouteCollection A RouteCollection instance
+     * @return RouteCollection
      */
     public function getRoutes();
 }

Loader/AnnotationClassLoader.php

@@ -104,7 +104,7 @@ public function setRouteAnnotationClass(string $class)
      *
      * @param string $class A class name
      *
-     * @return RouteCollection A RouteCollection instance
+     * @return RouteCollection
      *
      * @throws \InvalidArgumentException When route can't be parsed
      */

Loader/AnnotationDirectoryLoader.php

@@ -28,7 +28,7 @@ class AnnotationDirectoryLoader extends AnnotationFileLoader
      * @param string      $path A directory path
      * @param string|null $type The resource type
      *
-     * @return RouteCollection A RouteCollection instance
+     * @return RouteCollection
      *
      * @throws \InvalidArgumentException When the directory does not exist or its routes cannot be parsed
      */

Loader/AnnotationFileLoader.php

@@ -43,7 +43,7 @@ public function __construct(FileLocatorInterface $locator, AnnotationClassLoader
      * @param string      $file A PHP file path
      * @param string|null $type The resource type
      *
-     * @return RouteCollection|null A RouteCollection instance
+     * @return RouteCollection|null
      *
      * @throws \InvalidArgumentException When the file does not exist or its routes cannot be parsed
      */

Loader/ClosureLoader.php

@@ -29,7 +29,7 @@ class ClosureLoader extends Loader
      * @param \Closure    $closure A Closure
      * @param string|null $type    The resource type
      *
-     * @return RouteCollection A RouteCollection instance
+     * @return RouteCollection
      */
     public function load($closure, string $type = null)
     {

Loader/PhpFileLoader.php

@@ -33,7 +33,7 @@ class PhpFileLoader extends FileLoader
      * @param string      $file A PHP file path
      * @param string|null $type The resource type
      *
-     * @return RouteCollection A RouteCollection instance
+     * @return RouteCollection
      */
     public function load($file, string $type = null)
     {

Loader/XmlFileLoader.php

@@ -40,7 +40,7 @@ class XmlFileLoader extends FileLoader
      * @param string      $file An XML file path
      * @param string|null $type The resource type
      *
-     * @return RouteCollection A RouteCollection instance
+     * @return RouteCollection
      *
      * @throws \InvalidArgumentException when the file cannot be loaded or when the XML cannot be
      *                                   parsed because it does not validate against the scheme

Loader/YamlFileLoader.php

@@ -44,7 +44,7 @@ class YamlFileLoader extends FileLoader
      * @param string      $file A Yaml file path
      * @param string|null $type The resource type
      *
-     * @return RouteCollection A RouteCollection instance
+     * @return RouteCollection
      *
      * @throws \InvalidArgumentException When a route can't be parsed because YAML is invalid
      */

Matcher/Dumper/MatcherDumperInterface.php

@@ -31,7 +31,7 @@ public function dump(array $options = []);
     /**
      * Gets the routes to dump.
      *
-     * @return RouteCollection A RouteCollection instance
+     * @return RouteCollection
      */
     public function getRoutes();
 }

Route.php

@@ -439,7 +439,7 @@ public function setCondition(?string $condition)
     /**
      * Compiles the route.
      *
-     * @return CompiledRoute A CompiledRoute instance
+     * @return CompiledRoute
      *
      * @throws \LogicException If the Route cannot be compiled because the
      *                         path or host pattern is invalid

RouteCollection.php

@@ -112,7 +112,7 @@ public function all()
     /**
      * Gets a route by name.
      *
-     * @return Route|null A Route instance or null when not found
+     * @return Route|null
      */
     public function get(string $name)
     {

RouteCompilerInterface.php

@@ -21,7 +21,7 @@ interface RouteCompilerInterface
     /**
      * Compiles the current route instance.
      *
-     * @return CompiledRoute A CompiledRoute instance
+     * @return CompiledRoute
      *
      * @throws \LogicException If the Route cannot be compiled because the
      *                         path or host pattern is invalid

Router.php

@@ -303,7 +303,7 @@ function (ConfigCacheInterface $cache) {
     /**
      * Gets the UrlGenerator instance associated with this Router.
      *
-     * @return UrlGeneratorInterface A UrlGeneratorInterface instance
+     * @return UrlGeneratorInterface
      */
     public function getGenerator()
     {

RouterInterface.php

@@ -29,7 +29,7 @@ interface RouterInterface extends UrlMatcherInterface, UrlGeneratorInterface
      * WARNING: This method should never be used at runtime as it is SLOW.
      *          You might use it in a cache warmer though.
      *
-     * @return RouteCollection A RouteCollection instance
+     * @return RouteCollection
      */
     public function getRouteCollection();
 }