Skip to content

Commit 75ed961

Browse files
GrahamCampbellGrahamCampbell
committed
Docblock fixes
1 parent 9e4a8b2 commit 75ed961

14 files changed

+57
-56
lines changed

‎Constraint.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ public function validatedBy()
208208
* This method should return one or more of the constants
209209
* Constraint::CLASS_CONSTRAINT and Constraint::PROPERTY_CONSTRAINT.
210210
*
211-
* @return string|array One or more constant values
211+
* @return string|array One or more constant values
212212
*
213213
* @api
214214
*/

‎ConstraintViolation.php

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -61,20 +61,20 @@ class ConstraintViolation implements ConstraintViolationInterface
6161
/**
6262
* Creates a new constraint violation.
6363
*
64-
* @param string $message The violation message.
65-
* @param string $messageTemplate The raw violation message.
66-
* @param array $messageParameters The parameters to substitute
67-
* in the raw message.
68-
* @param mixed $root The value originally passed
69-
* to the validator.
70-
* @param string $propertyPath The property path from the
71-
* root value to the invalid
72-
* value.
73-
* @param mixed $invalidValue The invalid value causing the
74-
* violation.
75-
* @param int|null $messagePluralization The pluralization parameter.
76-
* @param mixed $code The error code of the
77-
* violation, if any.
64+
* @param string $message The violation message.
65+
* @param string $messageTemplate The raw violation message.
66+
* @param array $messageParameters The parameters to substitute
67+
* in the raw message.
68+
* @param mixed $root The value originally passed
69+
* to the validator.
70+
* @param string $propertyPath The property path from the
71+
* root value to the invalid
72+
* value.
73+
* @param mixed $invalidValue The invalid value causing the
74+
* violation.
75+
* @param int|null $messagePluralization The pluralization parameter.
76+
* @param mixed $code The error code of the
77+
* violation, if any.
7878
*/
7979
public function __construct($message, $messageTemplate, array $messageParameters, $root, $propertyPath, $invalidValue, $messagePluralization = null, $code = null)
8080
{

‎ConstraintViolationInterface.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ public function getMessageParameters();
8585
* This method returns the value of the parameter for choosing the right
8686
* pluralization form (in this case "choices").
8787
*
88-
* @return int|null The number to use to pluralize of the message.
88+
* @return int|null The number to use to pluralize of the message.
8989
*/
9090
public function getMessagePluralization();
9191

‎ConstraintViolationListInterface.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ public function addAll(ConstraintViolationListInterface $otherList);
4141
/**
4242
* Returns the violation at a given offset.
4343
*
44-
* @param int $offset The offset of the violation.
44+
* @param int $offset The offset of the violation.
4545
*
4646
* @return ConstraintViolationInterface The violation.
4747
*
@@ -54,9 +54,9 @@ public function get($offset);
5454
/**
5555
* Returns whether the given offset exists.
5656
*
57-
* @param int $offset The violation offset.
57+
* @param int $offset The violation offset.
5858
*
59-
* @return bool Whether the offset exists.
59+
* @return bool Whether the offset exists.
6060
*
6161
* @api
6262
*/
@@ -75,7 +75,7 @@ public function set($offset, ConstraintViolationInterface $violation);
7575
/**
7676
* Removes a violation at a given offset.
7777
*
78-
* @param int $offset The offset to remove.
78+
* @param int $offset The offset to remove.
7979
*
8080
* @api
8181
*/

‎Constraints/AbstractComparisonValidator.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,10 @@ public function validate($value, Constraint $constraint)
4242
/**
4343
* Compares the two given values to find if their relationship is valid
4444
*
45-
* @param mixed $value1 The first value to compare
46-
* @param mixed $value2 The second value to compare
45+
* @param mixed $value1 The first value to compare
46+
* @param mixed $value2 The second value to compare
4747
*
48-
* @return bool true if the relationship is valid, false otherwise
48+
* @return bool true if the relationship is valid, false otherwise
4949
*/
5050
abstract protected function compareValues($value1, $value2);
5151
}

‎Constraints/CardSchemeValidator.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ class CardSchemeValidator extends ConstraintValidator
9898
/**
9999
* Validates a creditcard belongs to a specified scheme.
100100
*
101-
* @param mixed $value
101+
* @param mixed $value
102102
* @param Constraint $constraint
103103
*/
104104
public function validate($value, Constraint $constraint)

‎DefaultTranslator.php

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -117,11 +117,11 @@ public function trans($id, array $parameters = array(), $domain = null, $locale
117117
*
118118
* // -> These are 3 donkeys.
119119
*
120-
* @param string $id The message id
121-
* @param int $number The number to use to find the index of the message
122-
* @param array $parameters An array of parameters for the message
123-
* @param string $domain Ignored
124-
* @param string $locale Ignored
120+
* @param string $id The message id
121+
* @param int $number The number to use to find the index of the message
122+
* @param array $parameters An array of parameters for the message
123+
* @param string $domain Ignored
124+
* @param string $locale Ignored
125125
*
126126
* @return string The translated string
127127
*

‎ExecutionContextInterface.php

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -88,11 +88,11 @@ interface ExecutionContextInterface
8888
/**
8989
* Adds a violation at the current node of the validation graph.
9090
*
91-
* @param string $message The error message.
92-
* @param array $params The parameters substituted in the error message.
93-
* @param mixed $invalidValue The invalid, validated value.
94-
* @param int|null $pluralization The number to use to pluralize of the message.
95-
* @param int|null $code The violation code.
91+
* @param string $message The error message.
92+
* @param array $params The parameters substituted in the error message.
93+
* @param mixed $invalidValue The invalid, validated value.
94+
* @param int|null $pluralization The number to use to pluralize of the message.
95+
* @param int|null $code The violation code.
9696
*
9797
* @api
9898
*/
@@ -102,12 +102,12 @@ public function addViolation($message, array $params = array(), $invalidValue =
102102
* Adds a violation at the validation graph node with the given property
103103
* path relative to the current property path.
104104
*
105-
* @param string $subPath The relative property path for the violation.
106-
* @param string $message The error message.
107-
* @param array $params The parameters substituted in the error message.
108-
* @param mixed $invalidValue The invalid, validated value.
109-
* @param int|null $pluralization The number to use to pluralize of the message.
110-
* @param int|null $code The violation code.
105+
* @param string $subPath The relative property path for the violation.
106+
* @param string $message The error message.
107+
* @param array $params The parameters substituted in the error message.
108+
* @param mixed $invalidValue The invalid, validated value.
109+
* @param int|null $pluralization The number to use to pluralize of the message.
110+
* @param int|null $code The violation code.
111111
*
112112
* @api
113113
*/

‎Mapping/ClassMetadata.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ public function __sleep()
138138
/**
139139
* Returns the fully qualified name of the class
140140
*
141-
* @return string The fully qualified class name
141+
* @return string The fully qualified class name
142142
*/
143143
public function getClassName()
144144
{
@@ -158,7 +158,7 @@ public function getClassName()
158158
* will validate the group sequence. The constraints assigned to "Default"
159159
* can still be validated by validating the class in "<ClassName>".
160160
*
161-
* @return string The name of the default group
161+
* @return string The name of the default group
162162
*/
163163
public function getDefaultGroup()
164164
{
@@ -400,7 +400,7 @@ public function getReflectionClass()
400400
/**
401401
* Sets whether a group sequence provider should be used.
402402
*
403-
* @param bool $active
403+
* @param bool $active
404404
*
405405
* @throws GroupDefinitionException
406406
*/

‎Mapping/Loader/AbstractLoader.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,10 @@ protected function addNamespaceAlias($alias, $namespace)
3636
/**
3737
* Creates a new constraint instance for the given constraint name.
3838
*
39-
* @param string $name The constraint name. Either a constraint relative
40-
* to the default constraint namespace, or a fully
41-
* qualified class name
42-
* @param mixed $options The constraint options
39+
* @param string $name The constraint name. Either a constraint relative
40+
* to the default constraint namespace, or a fully
41+
* qualified class name
42+
* @param mixed $options The constraint options
4343
*
4444
* @return Constraint
4545
*

‎MetadataFactoryInterface.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ public function getMetadataFor($value);
3434
*
3535
* @param mixed $value Some value.
3636
*
37-
* @return bool Whether metadata exists for the value.
37+
* @return bool Whether metadata exists for the value.
3838
*/
3939
public function hasMetadataFor($value);
4040
}

‎Tests/Constraints/AbstractComparisonValidatorTestCase.php

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,8 @@ public function testInvalidComparisonToValue($dirtyValue, $dirtyValueAsString, $
9797
abstract public function provideInvalidComparisons();
9898

9999
/**
100-
* @param array $options Options for the constraint
100+
* @param array $options Options for the constraint
101+
*
101102
* @return Constraint
102103
*/
103104
abstract protected function createConstraint(array $options);

‎Tests/Constraints/AbstractConstraintValidatorTest.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ protected function createContext()
8080
}
8181

8282
/**
83-
* @param $message
83+
* @param mixed $message
8484
* @param array $parameters
8585
* @param string $propertyPath
8686
* @param string $invalidValue
@@ -182,7 +182,7 @@ protected function assertNoViolation()
182182
}
183183

184184
/**
185-
* @param $message
185+
* @param mixed $message
186186
* @param array $parameters
187187
* @param string $propertyPath
188188
* @param string $invalidValue

‎ValidationVisitorInterface.php

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -54,11 +54,11 @@ interface ValidationVisitorInterface
5454
* does not find metadata for the given value, it will fail with an
5555
* exception.
5656
*
57-
* @param mixed $value The value to validate.
58-
* @param string $group The validation group to validate.
59-
* @param string $propertyPath The current property path in the validation graph.
60-
* @param bool $traverse Whether to traverse the value if it is traversable.
61-
* @param bool $deep Whether to traverse nested traversable values recursively.
57+
* @param mixed $value The value to validate.
58+
* @param string $group The validation group to validate.
59+
* @param string $propertyPath The current property path in the validation graph.
60+
* @param bool $traverse Whether to traverse the value if it is traversable.
61+
* @param bool $deep Whether to traverse nested traversable values recursively.
6262
*
6363
* @throws Exception\NoSuchMetadataException If no metadata can be found for
6464
* the given value.

0 commit comments

Comments
 (0)