Cleanup more @return annotations

Author: nicolas-grekas

Constraint.php

@@ -61,7 +61,7 @@ abstract class Constraint
     /**
      * Returns the name of the given error code.
      *
-     * @return string The name of the error code
+     * @return string
      *
      * @throws InvalidArgumentException If the error code does not exist
      */
@@ -201,7 +201,7 @@ public function __set(string $option, $value)
      * this method will be called at most once per constraint instance and
      * option name.
      *
-     * @return mixed The value of the option
+     * @return mixed
      *
      * @throws InvalidOptionsException If an invalid option name is given
      */

ConstraintValidator.php

@@ -54,7 +54,7 @@ public function initialize(ExecutionContextInterface $context)
      *
      * @param mixed $value The value to return the type of
      *
-     * @return string The type of the value
+     * @return string
      */
     protected function formatTypeOf($value)
     {
@@ -82,7 +82,7 @@ protected function formatTypeOf($value)
      * @param int   $format A bitwise combination of the format
      *                      constants in this class
      *
-     * @return string The string representation of the passed value
+     * @return string
      */
     protected function formatValue($value, int $format = 0)
     {
@@ -144,7 +144,7 @@ protected function formatValue($value, int $format = 0)
      * @param int   $format A bitwise combination of the format
      *                      constants in this class
      *
-     * @return string The string representation of the value list
+     * @return string
      *
      * @see formatValue()
      */

ConstraintViolation.php

@@ -70,7 +70,7 @@ public function __construct($message, ?string $messageTemplate, array $parameter
     /**
      * Converts the violation into a string for debugging purposes.
      *
-     * @return string The violation as string
+     * @return string
      */
     public function __toString()
     {
@@ -154,7 +154,7 @@ public function getInvalidValue()
     /**
      * Returns the constraint whose validation caused the violation.
      *
-     * @return Constraint|null The constraint or null if it is not known
+     * @return Constraint|null
      */
     public function getConstraint()
     {

ConstraintViolationInterface.php

@@ -36,7 +36,7 @@ interface ConstraintViolationInterface
     /**
      * Returns the violation message.
      *
-     * @return string|\Stringable The violation message as a string or a stringable object
+     * @return string|\Stringable
      */
     public function getMessage();
 
@@ -114,7 +114,7 @@ public function getInvalidValue();
     /**
      * Returns a machine-digestible error code for the violation.
      *
-     * @return string|null The error code
+     * @return string|null
      */
     public function getCode();
 }

ConstraintViolationList.php

@@ -46,7 +46,7 @@ public static function createFromMessage(string $message): self
     /**
      * Converts the violation into a string for debugging purposes.
      *
-     * @return string The violation as string
+     * @return string
      */
     public function __toString()
     {

ConstraintViolationListInterface.php

@@ -33,7 +33,7 @@ public function addAll(self $otherList);
      *
      * @param int $offset The offset of the violation
      *
-     * @return ConstraintViolationInterface The violation
+     * @return ConstraintViolationInterface
      *
      * @throws \OutOfBoundsException if the offset does not exist
      */
@@ -44,7 +44,7 @@ public function get(int $offset);
      *
      * @param int $offset The violation offset
      *
-     * @return bool Whether the offset exists
+     * @return bool
      */
     public function has(int $offset);
 

Constraints/AbstractComparisonValidator.php

@@ -106,14 +106,14 @@ private function getPropertyAccessor(): PropertyAccessorInterface
      * @param mixed $value1 The first value to compare
      * @param mixed $value2 The second value to compare
      *
-     * @return bool true if the relationship is valid, false otherwise
+     * @return bool
      */
     abstract protected function compareValues($value1, $value2);
 
     /**
      * Returns the error code used if the comparison fails.
      *
-     * @return string|null The error code or `null` if no code should be set
+     * @return string|null
      */
     protected function getErrorCode()
     {

Constraints/Composite.php

@@ -130,7 +130,7 @@ public function addImplicitGroupName(string $group)
     /**
      * Returns the name of the property that contains the nested constraints.
      *
-     * @return string The property name
+     * @return string
      */
     abstract protected function getCompositeOption();
 

Context/ExecutionContextFactoryInterface.php

@@ -29,7 +29,7 @@ interface ExecutionContextFactoryInterface
      * @param mixed $root The root value of the validated
      *                    object graph
      *
-     * @return ExecutionContextInterface The new execution context
+     * @return ExecutionContextInterface
      */
     public function createContext(ValidatorInterface $validator, $root);
 }

Context/ExecutionContextInterface.php

@@ -84,7 +84,7 @@ public function addViolation(string $message, array $params = []);
      * @param string|\Stringable $message    The error message as a string or a stringable object
      * @param array              $parameters The parameters substituted in the error message
      *
-     * @return ConstraintViolationBuilderInterface The violation builder
+     * @return ConstraintViolationBuilderInterface
      */
     public function buildViolation(string $message, array $parameters = []);
 
@@ -118,7 +118,7 @@ public function getValidator();
      *
      * In other cases, null is returned.
      *
-     * @return object|null The currently validated object or null
+     * @return object|null
      */
     public function getObject();
 
@@ -171,8 +171,7 @@ public function markGroupAsValidated(string $cacheKey, string $groupHash);
      * @param string $groupHash The group's name or hash, if it is group
      *                          sequence
      *
-     * @return bool Whether the object was already validated for that
-     *              group
+     * @return bool
      *
      * @internal Used by the validator engine. Should not be called by user
      *           code.
@@ -196,7 +195,7 @@ public function markConstraintAsValidated(string $cacheKey, string $constraintHa
      * @param string $cacheKey       The hash of the object
      * @param string $constraintHash The hash of the constraint
      *
-     * @return bool Whether the constraint was already validated
+     * @return bool
      *
      * @internal Used by the validator engine. Should not be called by user
      *           code.
@@ -220,7 +219,7 @@ public function markObjectAsInitialized(string $cacheKey);
      *
      * @param string $cacheKey The hash of the object
      *
-     * @return bool Whether the object was already initialized
+     * @return bool
      *
      * @internal Used by the validator engine. Should not be called by user
      *           code.
@@ -232,7 +231,7 @@ public function isObjectInitialized(string $cacheKey);
     /**
      * Returns the violations generated by the validator so far.
      *
-     * @return ConstraintViolationListInterface The constraint violation list
+     * @return ConstraintViolationListInterface
      */
     public function getViolations();
 
@@ -245,7 +244,7 @@ public function getViolations();
      *
      * The current value is returned by {@link getValue}.
      *
-     * @return mixed The root value of the validation
+     * @return mixed
      */
     public function getRoot();
 
@@ -255,7 +254,7 @@ public function getRoot();
      * If you want to retrieve the object that was originally passed to the
      * validator, use {@link getRoot}.
      *
-     * @return mixed The currently validated value
+     * @return mixed
      */
     public function getValue();
 
@@ -272,15 +271,14 @@ public function getValue();
      * has been called with a plain value and constraint, this method returns
      * null.
      *
-     * @return MetadataInterface|null the metadata of the currently validated
-     *                                value
+     * @return MetadataInterface|null
      */
     public function getMetadata();
 
     /**
      * Returns the validation group that is currently being validated.
      *
-     * @return string|null The current validation group
+     * @return string|null
      */
     public function getGroup();
 
@@ -291,7 +289,7 @@ public function getGroup();
      * {@link Mapping\ClassMetadataInterface} or if no metadata is available for the
      * current node, this method returns null.
      *
-     * @return string|null The class name or null, if no class name could be found
+     * @return string|null
      */
     public function getClassName();
 
@@ -302,7 +300,7 @@ public function getClassName();
      * {@link PropertyMetadataInterface} or if no metadata is available for the
      * current node, this method returns null.
      *
-     * @return string|null The property name or null, if no property name could be found
+     * @return string|null
      */
     public function getPropertyName();
 

GroupSequenceProviderInterface.php

@@ -22,7 +22,7 @@ interface GroupSequenceProviderInterface
      * Returns which validation groups should be used for a certain state
      * of the object.
      *
-     * @return string[]|string[][]|GroupSequence An array of validation groups
+     * @return string[]|string[][]|GroupSequence
      */
     public function getGroupSequence();
 }

Mapping/ClassMetadata.php

@@ -164,7 +164,7 @@ public function getClassName()
      * will validate the group sequence. The constraints assigned to "Default"
      * can still be validated by validating the class in "<ClassName>".
      *
-     * @return string The name of the default group
+     * @return string
      */
     public function getDefaultGroup()
     {

Mapping/ClassMetadataInterface.php

@@ -11,6 +11,9 @@
 
 namespace Symfony\Component\Validator\Mapping;
 
+use Symfony\Component\Validator\Constraints\GroupSequence;
+use Symfony\Component\Validator\GroupSequenceProviderInterface;
+
 /**
  * Stores all metadata needed for validating objects of specific class.
  *
@@ -24,16 +27,16 @@
  * @author Bernhard Schussek <[email protected]>
  *
  * @see MetadataInterface
- * @see \Symfony\Component\Validator\Constraints\GroupSequence
- * @see \Symfony\Component\Validator\GroupSequenceProviderInterface
+ * @see GroupSequence
+ * @see GroupSequenceProviderInterface
  * @see TraversalStrategy
  */
 interface ClassMetadataInterface extends MetadataInterface
 {
     /**
      * Returns the names of all constrained properties.
      *
-     * @return string[] A list of property names
+     * @return string[]
      */
     public function getConstrainedProperties();
 
@@ -42,19 +45,15 @@ public function getConstrainedProperties();
      *
      * If it is, you can access the group sequence with {@link getGroupSequence()}.
      *
-     * @return bool Returns true if the "Default" group is overridden
-     *
-     * @see \Symfony\Component\Validator\Constraints\GroupSequence
+     * @return bool
      */
     public function hasGroupSequence();
 
     /**
      * Returns the group sequence that overrides the "Default" group for this
      * class.
      *
-     * @return \Symfony\Component\Validator\Constraints\GroupSequence|null The group sequence or null
-     *
-     * @see \Symfony\Component\Validator\Constraints\GroupSequence
+     * @return GroupSequence|null
      */
     public function getGroupSequence();
 
@@ -63,14 +62,11 @@ public function getGroupSequence();
      * sequence obtained by the validated objects.
      *
      * If this method returns true, the class must implement
-     * {@link \Symfony\Component\Validator\GroupSequenceProviderInterface}.
+     * {@link GroupSequenceProviderInterface}.
      * This interface will be used to obtain the group sequence when an object
      * of this class is validated.
      *
-     * @return bool Returns true if the "Default" group is overridden by
-     *              a dynamic group sequence
-     *
-     * @see \Symfony\Component\Validator\GroupSequenceProviderInterface
+     * @return bool
      */
     public function isGroupSequenceProvider();
 
@@ -98,7 +94,7 @@ public function getPropertyMetadata(string $property);
     /**
      * Returns the name of the backing PHP class.
      *
-     * @return string The name of the backing class
+     * @return string
      */
     public function getClassName();
 }

Mapping/Factory/MetadataFactoryInterface.php

@@ -26,7 +26,7 @@ interface MetadataFactoryInterface
      *
      * @param mixed $value Some value
      *
-     * @return MetadataInterface The metadata for the value
+     * @return MetadataInterface
      *
      * @throws NoSuchMetadataException If no metadata exists for the given value
      */
@@ -37,7 +37,7 @@ public function getMetadataFor($value);
      *
      * @param mixed $value Some value
      *
-     * @return bool Whether metadata can be returned for that value
+     * @return bool
      */
     public function hasMetadataFor($value);
 }

Mapping/Loader/FilesLoader.php

@@ -35,7 +35,7 @@ public function __construct(array $paths)
     /**
      * Returns an array of file loaders for the given file paths.
      *
-     * @return LoaderInterface[] The metadata loaders
+     * @return LoaderInterface[]
      */
     protected function getFileLoaders(array $paths)
     {
@@ -51,7 +51,7 @@ protected function getFileLoaders(array $paths)
     /**
      * Creates a loader for the given file path.
      *
-     * @return LoaderInterface The created loader
+     * @return LoaderInterface
      */
     abstract protected function getFileLoaderInstance(string $path);
 }

Mapping/Loader/LoaderInterface.php

@@ -23,7 +23,7 @@ interface LoaderInterface
     /**
      * Loads validation metadata into a {@link ClassMetadata} instance.
      *
-     * @return bool Whether the loader succeeded
+     * @return bool
      */
     public function loadClassMetadata(ClassMetadata $metadata);
 }