Skip to content

Commit

Permalink
Docblock fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
GrahamCampbell committed Nov 30, 2014
1 parent be0828a commit 8d89522
Show file tree
Hide file tree
Showing 10 changed files with 35 additions and 35 deletions.
16 changes: 8 additions & 8 deletions CompiledRoute.php
Expand Up @@ -30,14 +30,14 @@ class CompiledRoute implements \Serializable
/**
* Constructor.
*
* @param string $staticPrefix The static prefix of the compiled route
* @param string $regex The regular expression to use to match this route
* @param array $tokens An array of tokens to use to generate URL for this route
* @param array $pathVariables An array of path variables
* @param string|null $hostRegex Host regex
* @param array $hostTokens Host tokens
* @param array $hostVariables An array of host variables
* @param array $variables An array of variables (variables defined in the path and in the host patterns)
* @param string $staticPrefix The static prefix of the compiled route
* @param string $regex The regular expression to use to match this route
* @param array $tokens An array of tokens to use to generate URL for this route
* @param array $pathVariables An array of path variables
* @param string|null $hostRegex Host regex
* @param array $hostTokens Host tokens
* @param array $hostVariables An array of host variables
* @param array $variables An array of variables (variables defined in the path and in the host patterns)
*/
public function __construct($staticPrefix, $regex, array $tokens, array $pathVariables, $hostRegex = null, array $hostTokens = array(), array $hostVariables = array(), array $variables = array())
{
Expand Down
2 changes: 1 addition & 1 deletion Generator/ConfigurableRequirementsInterface.php
Expand Up @@ -41,7 +41,7 @@ interface ConfigurableRequirementsInterface
* Enables or disables the exception on incorrect parameters.
* Passing null will deactivate the requirements check completely.
*
* @param bool|null $enabled
* @param bool|null $enabled
*/
public function setStrictRequirements($enabled);

Expand Down
6 changes: 3 additions & 3 deletions Generator/UrlGeneratorInterface.php
Expand Up @@ -70,9 +70,9 @@ interface UrlGeneratorInterface extends RequestContextAwareInterface
*
* If there is no route with the given name, the generator must throw the RouteNotFoundException.
*
* @param string $name The name of the route
* @param mixed $parameters An array of parameters
* @param bool|string $referenceType The type of reference to be generated (one of the constants)
* @param string $name The name of the route
* @param mixed $parameters An array of parameters
* @param bool|string $referenceType The type of reference to be generated (one of the constants)
*
* @return string The generated URL
*
Expand Down
12 changes: 6 additions & 6 deletions Matcher/Dumper/ApacheMatcherDumper.php
Expand Up @@ -105,10 +105,10 @@ public function dump(array $options = array())
/**
* Dumps a single route
*
* @param string $name Route name
* @param Route $route The route
* @param array $options Options
* @param bool $hostRegexUnique Unique identifier for the host regex
* @param string $name Route name
* @param Route $route The route
* @param array $options Options
* @param bool $hostRegexUnique Unique identifier for the host regex
*
* @return string The compiled route
*/
Expand Down Expand Up @@ -184,7 +184,7 @@ private function dumpRoute($name, $route, array $options, $hostRegexUnique)
/**
* Returns methods allowed for a route
*
* @param Route $route The route
* @param Route $route The route
*
* @return array The methods
*/
Expand All @@ -205,7 +205,7 @@ private function getRouteMethods(Route $route)
/**
* Converts a regex to make it suitable for mod_rewrite
*
* @param string $regex The regex
* @param string $regex The regex
*
* @return string The converted regex
*/
Expand Down
2 changes: 1 addition & 1 deletion Matcher/Dumper/DumperCollection.php
Expand Up @@ -116,7 +116,7 @@ protected function setParent(DumperCollection $parent)
*
* @param string $name The attribute name
*
* @return bool true if the attribute is defined, false otherwise
* @return bool true if the attribute is defined, false otherwise
*/
public function hasAttribute($name)
{
Expand Down
2 changes: 1 addition & 1 deletion Matcher/Dumper/PhpMatcherDumper.php
Expand Up @@ -78,7 +78,7 @@ public function __construct(RequestContext \$context)
/**
* Generates the code for the match method implementing UrlMatcherInterface.
*
* @param bool $supportsRedirections Whether redirections are supported by the base class
* @param bool $supportsRedirections Whether redirections are supported by the base class
*
* @return string Match method as PHP code
*/
Expand Down
16 changes: 8 additions & 8 deletions RequestContext.php
Expand Up @@ -40,14 +40,14 @@ class RequestContext
/**
* Constructor.
*
* @param string $baseUrl The base URL
* @param string $method The HTTP method
* @param string $host The HTTP host name
* @param string $scheme The HTTP scheme
* @param int $httpPort The HTTP port
* @param int $httpsPort The HTTPS port
* @param string $path The path
* @param string $queryString The query string
* @param string $baseUrl The base URL
* @param string $method The HTTP method
* @param string $host The HTTP host name
* @param string $scheme The HTTP scheme
* @param int $httpPort The HTTP port
* @param int $httpsPort The HTTPS port
* @param string $path The path
* @param string $queryString The query string
*
* @api
*/
Expand Down
6 changes: 3 additions & 3 deletions Route.php
Expand Up @@ -372,7 +372,7 @@ public function getOption($name)
*
* @param string $name An option name
*
* @return bool true if the option is set, false otherwise
* @return bool true if the option is set, false otherwise
*/
public function hasOption($name)
{
Expand Down Expand Up @@ -441,7 +441,7 @@ public function getDefault($name)
*
* @param string $name A variable name
*
* @return bool true if the default value is set, false otherwise
* @return bool true if the default value is set, false otherwise
*/
public function hasDefault($name)
{
Expand Down Expand Up @@ -528,7 +528,7 @@ public function getRequirement($key)
*
* @param string $key A variable name
*
* @return bool true if a requirement is specified, false otherwise
* @return bool true if a requirement is specified, false otherwise
*/
public function hasRequirement($key)
{
Expand Down
2 changes: 1 addition & 1 deletion RouteCollection.php
Expand Up @@ -121,7 +121,7 @@ public function remove($name)
* Adds a route collection at the end of the current set by appending all
* routes of the added collection.
*
* @param RouteCollection $collection A RouteCollection instance
* @param RouteCollection $collection A RouteCollection instance
*
* @api
*/
Expand Down
6 changes: 3 additions & 3 deletions RouteCompiler.php
Expand Up @@ -191,9 +191,9 @@ private static function findNextSeparator($pattern)
/**
* Computes the regexp used to match a specific token. It can be static text or a subpattern.
*
* @param array $tokens The route tokens
* @param int $index The index of the current token
* @param int $firstOptional The index of the first optional token
* @param array $tokens The route tokens
* @param int $index The index of the current token
* @param int $firstOptional The index of the first optional token
*
* @return string The regexp pattern for a single token
*/
Expand Down

0 comments on commit 8d89522

Please sign in to comment.