some phpdoc improvements

Author: dbu

RouteProviderInterface.php

@@ -38,7 +38,7 @@ interface RouteProviderInterface
     public function getRouteCollectionForRequest(Request $request);
 
     /**
-     * Find the route using the provided route name (and parameters)
+     * Find the route using the provided route name.
      *
      * @param string $name       the route name to fetch
      * @param array  $parameters DEPRECATED the parameters as they are passed
@@ -52,14 +52,15 @@ public function getRouteCollectionForRequest(Request $request);
     public function getRouteByName($name, $parameters = array());
 
     /**
-     * Find many routes by their names using the provided list of names
+     * Find many routes by their names using the provided list of names.
      *
      * Note that this method may not throw an exception if some of the routes
-     * are not found. It will just return the list of those routes it found.
+     * are not found or are not actually Route instances. It will just return the
+     * list of those Route instances it found.
      *
      * This method exists in order to allow performance optimizations. The
      * simple implementation could be to just repeatedly call
-     * $this->getRouteByName()
+     * $this->getRouteByName() while catching and ignoring eventual exceptions.
      *
      * @param array $names      the list of names to retrieve
      * @param array $parameters DEPRECATED the parameters as they are passed to

Tests/Routing/ContentAwareGeneratorTest.php

@@ -276,13 +276,18 @@ public function testGenerateDocumentMultilangLocaleNomatch()
     }
 
     /**
+     * Generate without any information.
+     *
      * @expectedException \Symfony\Component\Routing\Exception\RouteNotFoundException
      */
     public function testGenerateNoContent()
     {
         $this->generator->generate('', array());
     }
+
     /**
+     * Generate with an object that is neither a route nor route aware.
+     *
      * @expectedException \Symfony\Component\Routing\Exception\RouteNotFoundException
      */
     public function testGenerateInvalidContent()
@@ -291,6 +296,8 @@ public function testGenerateInvalidContent()
     }
 
     /**
+     * Generate with a content_id but there is no content repository.
+     *
      * @expectedException \Symfony\Component\Routing\Exception\RouteNotFoundException
      */
     public function testGenerateNoContentRepository()
@@ -303,6 +310,8 @@ public function testGenerateNoContentRepository()
     }
 
     /**
+     * Generate with content_id but the content is not found.
+     *
      * @expectedException \Symfony\Component\Routing\Exception\RouteNotFoundException
      */
     public function testGenerateNoContentFoundInRepository()
@@ -323,6 +332,8 @@ public function testGenerateNoContentFoundInRepository()
     }
 
     /**
+     * Generate with content_id but the object at id is not route aware.
+     *
      * @expectedException \Symfony\Component\Routing\Exception\RouteNotFoundException
      */
     public function testGenerateWrongContentClassInRepository()
@@ -343,6 +354,8 @@ public function testGenerateWrongContentClassInRepository()
     }
 
     /**
+     * Generate from a content that has no routes associated.
+     *
      * @expectedException \Symfony\Component\Routing\Exception\RouteNotFoundException
      */
     public function testGenerateNoRoutes()
@@ -354,6 +367,8 @@ public function testGenerateNoRoutes()
         $this->generator->generate($this->contentDocument);
     }
     /**
+     * Generate from a content that returns something that is not a route as route.
+     *
      * @expectedException \Symfony\Component\Routing\Exception\RouteNotFoundException
      */
     public function testGenerateInvalidRoute()