merged branch hhamon/phpdoc_fixes (PR #212)

Commits
-------

79e2684f [Silex] use @inheritdoc instead of a new phpdoc block.
46dc1dff [Silex] added missing PHPDoc blocks.

Discussion
----------

[Silex] added missing PHPDoc blocks.

src/Silex/Application.php

@@ -314,7 +314,7 @@ class Application extends \Pimple implements HttpKernelInterface, EventSubscribe
      * Mounts an application under the given route prefix.
      *
      * @param string $prefix The route prefix
-     * @param ControllerCollection|ControllerProviderInterface $app    A ControllerCollection or an ControllerProviderInterface instance
+     * @param ControllerCollection|ControllerProviderInterface $app A ControllerCollection or a ControllerProviderInterface instance
      */
     public function mount($prefix, $app)
     {
@@ -330,7 +330,7 @@ class Application extends \Pimple implements HttpKernelInterface, EventSubscribe
     }
 
     /**
-     * Handles the request and deliver the response.
+     * Handles the request and delivers the response.
      *
      * @param Request $request Request to process
      */
@@ -343,6 +343,9 @@ class Application extends \Pimple implements HttpKernelInterface, EventSubscribe
         $this->handle($request)->send();
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function handle(Request $request, $type = HttpKernelInterface::MASTER_REQUEST, $catch = true)
     {
         $this->beforeDispatched = false;
@@ -356,6 +359,8 @@ class Application extends \Pimple implements HttpKernelInterface, EventSubscribe
 
     /**
      * Handles onEarlyKernelRequest events.
+     *
+     * @param KernelEvent $event The event to handle
      */
     public function onEarlyKernelRequest(KernelEvent $event)
     {
@@ -369,6 +374,8 @@ class Application extends \Pimple implements HttpKernelInterface, EventSubscribe
 
     /**
      * Handles onKernelRequest events.
+     *
+     * @param KernelEvent $event The event to handle
      */
     public function onKernelRequest(KernelEvent $event)
     {

src/Silex/Compiler.php

@@ -24,6 +24,11 @@ class Compiler
 {
     protected $version;
 
+    /**
+     * Compiles the Silex source code into one single Phar file.
+     *
+     * @param string $pharFile Name of the output Phar file
+     */
     public function compile($pharFile = 'silex.phar')
     {
         if (file_exists($pharFile)) {

src/Silex/Controller.php

@@ -38,6 +38,8 @@ class Controller
 
     /**
      * Gets the controller's route.
+     *
+     * @return Route
      */
     public function getRoute()
     {
@@ -46,6 +48,8 @@ class Controller
 
     /**
      * Gets the controller's route name.
+     *
+     * @return string
      */
     public function getRouteName()
     {
@@ -56,6 +60,7 @@ class Controller
      * Sets the controller's route.
      *
      * @param string $routeName
+     * @return Controller $this The current Controller instance
      */
     public function bind($routeName)
     {
@@ -73,6 +78,7 @@ class Controller
      *
      * @param string $variable The variable name
      * @param string $regexp   The regexp to apply
+     * @return Controller $this The current Controller instance
      */
     public function assert($variable, $regexp)
     {
@@ -86,6 +92,7 @@ class Controller
      *
      * @param string $variable The variable name
      * @param mixed  $default  The default value
+     * @return Controller $this The current Controller instance
      */
     public function value($variable, $default)
     {
@@ -99,6 +106,7 @@ class Controller
      *
      * @param string $variable The variable name
      * @param mixed  $callback A PHP callback that converts the original value
+     * @return Controller $this The current Controller instance
      */
     public function convert($variable, $callback)
     {
@@ -112,8 +120,8 @@ class Controller
     /**
      * Sets the requirement for the HTTP method.
      *
-     * @param string $method The HTTP method name. Multiple methods can be supplied,
-     *                       delimited by a pipe character '|', eg. 'GET|POST'.
+     * @param string $method The HTTP method name. Multiple methods can be supplied, delimited by a pipe character '|', eg. 'GET|POST'.
+     * @return Controller $this The current Controller instance
      */
     public function method($method)
     {
@@ -124,6 +132,8 @@ class Controller
 
     /**
      * Sets the requirement of HTTP (no HTTPS) on this controller.
+     *
+     * @return Controller $this The current Controller instance
      */
     public function requireHttp()
     {
@@ -134,6 +144,8 @@ class Controller
 
     /**
      * Sets the requirement of HTTPS on this controller.
+     *
+     * @return Controller $this The current Controller instance
      */
     public function requireHttps()
     {

src/Silex/HttpCache.php

@@ -21,6 +21,11 @@ use Symfony\Component\HttpFoundation\Request;
  */
 class HttpCache extends BaseHttpCache
 {
+    /**
+     * Handles the Request and delivers the Response.
+     *
+     * @param Request $request The Request objet
+     */
     public function run(Request $request = null)
     {
         if (null === $request) {

src/Silex/LazyUrlMatcher.php

@@ -29,6 +29,11 @@ class LazyUrlMatcher implements UrlMatcherInterface
         $this->factory = $factory;
     }
 
+    /**
+     * Returns the corresponding UrlMatcherInterface instance.
+     *
+     * @return UrlMatcherInterface
+     */
     public function getUrlMatcher()
     {
         $urlMatcher = call_user_func($this->factory);

src/Silex/StringResponseConverter.php

@@ -23,9 +23,9 @@ class StringResponseConverter
     /**
      * Does the conversion
      *
-     * @param  $response The response string
+     * @param string $response The response string
      *
-     * @return A response object
+     * @return A Response object
      */
     public function convert($response)
     {