update docs

Author: miladrahimi

src/Dispatching/Caller.php

@@ -12,12 +12,14 @@
 class Caller
 {
     /**
+     * The dependency injection IoC container
+     *
      * @var Container
      */
     private $container;
 
     /**
-     * Caller constructor.
+     * Constructor
      *
      * @param Container $container
      */

src/Dispatching/Matcher.php

@@ -10,12 +10,14 @@
 class Matcher
 {
     /**
+     * Route repository that holds all the declared routes
+     *
      * @var Repository
      */
     private $repository;
 
     /**
-     * Matcher constructor.
+     * Constructor
      *
      * @param Repository $repository
      */

src/Router.php

@@ -27,14 +27,14 @@ class Router
     private $container;
 
     /**
-     * The storekeeper of route repository
+     * The storekeeper of the route repository
      *
      * @var Storekeeper
      */
     private $storekeeper;
 
     /**
-     * The route matcher that finds appropriate routes for requests
+     * The route matcher that finds appropriate routes for incoming requests
      *
      * @var Matcher
      */
@@ -48,7 +48,7 @@ class Router
     private $caller;
 
     /**
-     * The publisher that publish controller outputs
+     * The publisher that publish controller outputs (responses)
      *
      * @var Publisher
      */
@@ -62,7 +62,7 @@ class Router
     private $patterns = [];
 
     /**
-     * Router constructor.
+     * Constructor
      *
      * @param Container $container
      * @param Storekeeper $storekeeper
@@ -104,7 +104,7 @@ public static function create(): self
     /**
      * Group routes with the given attributes
      *
-     * @param array $attributes
+     * @param string[] $attributes
      * @param Closure $body
      */
     public function group(array $attributes, Closure $body): void
@@ -132,7 +132,7 @@ public function map(string $method, string $path, $controller, ?string $name = n
     }
 
     /**
-     * Dispatch routes and run the application
+     * Dispatch routes (and run the application)
      *
      * @throws ContainerException
      * @throws InvalidCallableException

src/Routing/Repository.php

@@ -56,7 +56,7 @@ public function findByMethod(string $method): array
     }
 
     /**
-     * Find route by given name
+     * Find route by the given name
      *
      * @param string $name
      * @return Route|null

src/Routing/Route.php

@@ -47,7 +47,7 @@ class Route
     private $parameters = [];
 
     /**
-     * Route constructor.
+     * Constructor
      *
      * @param string|null $name
      * @param string $path

src/Routing/State.php

@@ -20,7 +20,7 @@ class State
     private $domain;
 
     /**
-     * Attributes constructor.
+     * Constructor
      *
      * @param string $prefix
      * @param array $middleware

src/Routing/Storekeeper.php

@@ -5,17 +5,21 @@
 class Storekeeper
 {
     /**
+     * Route repository that holds all the declared routes
+     *
      * @var Repository
      */
     private $repository;
 
     /**
+     * The state that holds all the attributes for the prospective routes
+     *
      * @var State
      */
     private $state;
 
     /**
-     * Storekeeper constructor.
+     * Constructor
      *
      * @param Repository $repository
      * @param State $state

src/Url.php

@@ -8,12 +8,14 @@
 class Url
 {
     /**
+     * Route repository that holds all the declared routes
+     *
      * @var Repository
      */
     private $repository;
 
     /**
-     * Url constructor.
+     * Constructor
      *
      * @param Repository $repository
      */
@@ -23,7 +25,7 @@ public function __construct(Repository $repository)
     }
 
     /**
-     * Generate URL for given route name
+     * Generate URL for the given route name considering the given parameters
      *
      * @param string $routeName
      * @param string[] $parameters