fixed @return when returning this or static

Author: fabpot

Button.php

@@ -369,7 +369,7 @@ public function handleRequest($request = null)
      * @param null|string $submittedData The data
      * @param bool        $clearMissing  Not used
      *
-     * @return Button The button instance
+     * @return $this
      *
      * @throws Exception\AlreadySubmittedException If the button has already been submitted.
      */

ButtonBuilder.php

@@ -286,7 +286,7 @@ public function setDataMapper(DataMapperInterface $dataMapper = null)
      *
      * @param bool $disabled Whether the button is disabled
      *
-     * @return ButtonBuilder The button builder
+     * @return $this
      */
     public function setDisabled($disabled)
     {
@@ -415,7 +415,7 @@ public function setCompound($compound)
      *
      * @param ResolvedFormTypeInterface $type The type of the button
      *
-     * @return ButtonBuilder The button builder
+     * @return $this
      */
     public function setType(ResolvedFormTypeInterface $type)
     {
@@ -507,7 +507,7 @@ public function setRequestHandler(RequestHandlerInterface $requestHandler)
      *
      * @param bool $initialize
      *
-     * @return ButtonBuilder
+     * @return $this
      *
      * @throws BadMethodCallException
      */

FormBuilder.php

@@ -248,7 +248,7 @@ public function getIterator()
      *
      * @param string $name The name of the unresolved child
      *
-     * @return FormBuilder The created instance
+     * @return self The created instance
      */
     private function resolveChild($name)
     {

FormBuilderInterface.php

@@ -27,7 +27,7 @@ interface FormBuilderInterface extends \Traversable, \Countable, FormConfigBuild
      * @param string|FormTypeInterface        $type
      * @param array                           $options
      *
-     * @return FormBuilderInterface The builder object
+     * @return $this
      */
     public function add($child, $type = null, array $options = array());
 
@@ -38,7 +38,7 @@ public function add($child, $type = null, array $options = array());
      * @param string|FormTypeInterface $type    The type of the form or null if name is a property
      * @param array                    $options The options
      *
-     * @return FormBuilderInterface The created builder
+     * @return self
      */
     public function create($name, $type = null, array $options = array());
 
@@ -47,7 +47,7 @@ public function create($name, $type = null, array $options = array());
      *
      * @param string $name The name of the child
      *
-     * @return FormBuilderInterface The builder for the child
+     * @return self
      *
      * @throws Exception\InvalidArgumentException if the given child does not exist
      */
@@ -58,7 +58,7 @@ public function get($name);
      *
      * @param string $name
      *
-     * @return FormBuilderInterface The builder object
+     * @return $this
      */
     public function remove($name);
 

FormConfigBuilder.php

@@ -349,7 +349,7 @@ public function getInheritData()
     /**
      * Alias of {@link getInheritData()}.
      *
-     * @return FormConfigBuilder The configuration object
+     * @return bool
      *
      * @deprecated since version 2.3, to be removed in 3.0.
      *             Use {@link getInheritData()} instead.
@@ -715,8 +715,6 @@ public function setInheritData($inheritData)
      *
      * @param bool $inheritData Whether the form should inherit its parent's data
      *
-     * @return FormConfigBuilder The configuration object
-     *
      * @deprecated since version 2.3, to be removed in 3.0.
      *             Use {@link setInheritData()} instead.
      */

FormFactoryBuilderInterface.php

@@ -23,7 +23,7 @@ interface FormFactoryBuilderInterface
      *
      * @param ResolvedFormTypeFactoryInterface $resolvedTypeFactory
      *
-     * @return FormFactoryBuilderInterface The builder
+     * @return $this
      */
     public function setResolvedTypeFactory(ResolvedFormTypeFactoryInterface $resolvedTypeFactory);
 
@@ -32,7 +32,7 @@ public function setResolvedTypeFactory(ResolvedFormTypeFactoryInterface $resolve
      *
      * @param FormExtensionInterface $extension The extension
      *
-     * @return FormFactoryBuilderInterface The builder
+     * @return $this
      */
     public function addExtension(FormExtensionInterface $extension);
 
@@ -41,7 +41,7 @@ public function addExtension(FormExtensionInterface $extension);
      *
      * @param FormExtensionInterface[] $extensions The extensions
      *
-     * @return FormFactoryBuilderInterface The builder
+     * @return $this
      */
     public function addExtensions(array $extensions);
 
@@ -50,7 +50,7 @@ public function addExtensions(array $extensions);
      *
      * @param FormTypeInterface $type The form type
      *
-     * @return FormFactoryBuilderInterface The builder
+     * @return $this
      */
     public function addType(FormTypeInterface $type);
 
@@ -59,7 +59,7 @@ public function addType(FormTypeInterface $type);
      *
      * @param FormTypeInterface[] $types The form types
      *
-     * @return FormFactoryBuilderInterface The builder
+     * @return $this
      */
     public function addTypes(array $types);
 
@@ -68,7 +68,7 @@ public function addTypes(array $types);
      *
      * @param FormTypeExtensionInterface $typeExtension The form type extension
      *
-     * @return FormFactoryBuilderInterface The builder
+     * @return $this
      */
     public function addTypeExtension(FormTypeExtensionInterface $typeExtension);
 
@@ -77,7 +77,7 @@ public function addTypeExtension(FormTypeExtensionInterface $typeExtension);
      *
      * @param FormTypeExtensionInterface[] $typeExtensions The form type extensions
      *
-     * @return FormFactoryBuilderInterface The builder
+     * @return $this
      */
     public function addTypeExtensions(array $typeExtensions);
 
@@ -86,7 +86,7 @@ public function addTypeExtensions(array $typeExtensions);
      *
      * @param FormTypeGuesserInterface $typeGuesser The type guesser
      *
-     * @return FormFactoryBuilderInterface The builder
+     * @return $this
      */
     public function addTypeGuesser(FormTypeGuesserInterface $typeGuesser);
 
@@ -95,7 +95,7 @@ public function addTypeGuesser(FormTypeGuesserInterface $typeGuesser);
      *
      * @param FormTypeGuesserInterface[] $typeGuessers The type guessers
      *
-     * @return FormFactoryBuilderInterface The builder
+     * @return $this
      */
     public function addTypeGuessers(array $typeGuessers);
 

FormInterface.php

@@ -25,7 +25,7 @@ interface FormInterface extends \ArrayAccess, \Traversable, \Countable
      *
      * @param FormInterface|null $parent The parent form or null if it's the root
      *
-     * @return FormInterface The form instance
+     * @return self
      *
      * @throws Exception\AlreadySubmittedException If the form has already been submitted.
      * @throws Exception\LogicException            When trying to set a parent for a form with
@@ -36,7 +36,7 @@ public function setParent(FormInterface $parent = null);
     /**
      * Returns the parent form.
      *
-     * @return FormInterface|null The parent form or null if there is none
+     * @return self|null The parent form or null if there is none
      */
     public function getParent();
 
@@ -47,7 +47,7 @@ public function getParent();
      * @param string|null              $type    The child's type, if a name was passed
      * @param array                    $options The child's options, if a name was passed
      *
-     * @return FormInterface The form instance
+     * @return self
      *
      * @throws Exception\AlreadySubmittedException If the form has already been submitted.
      * @throws Exception\LogicException            When trying to add a child to a non-compound form.
@@ -60,7 +60,7 @@ public function add($child, $type = null, array $options = array());
      *
      * @param string $name The name of the child
      *
-     * @return FormInterface The child form
+     * @return self
      *
      * @throws \OutOfBoundsException If the named child does not exist.
      */
@@ -80,7 +80,7 @@ public function has($name);
      *
      * @param string $name The name of the child to remove
      *
-     * @return FormInterface The form instance
+     * @return $this
      *
      * @throws Exception\AlreadySubmittedException If the form has already been submitted.
      */
@@ -89,7 +89,7 @@ public function remove($name);
     /**
      * Returns all children in this group.
      *
-     * @return FormInterface[] An array of FormInterface instances
+     * @return self[]
      */
     public function all();
 
@@ -110,7 +110,7 @@ public function getErrors($deep = false, $flatten = true);
      *
      * @param mixed $modelData The data formatted as expected for the underlying object
      *
-     * @return FormInterface The form instance
+     * @return $this
      *
      * @throws Exception\AlreadySubmittedException If the form has already been submitted.
      * @throws Exception\LogicException            If listeners try to call setData in a cycle. Or if
@@ -182,7 +182,7 @@ public function getPropertyPath();
      *
      * @param FormError $error
      *
-     * @return FormInterface The form instance
+     * @return $this
      */
     public function addError(FormError $error);
 
@@ -248,7 +248,7 @@ public function getTransformationFailure();
      *
      * Should be called on the root form after constructing the tree.
      *
-     * @return FormInterface The form instance
+     * @return $this
      */
     public function initialize();
 
@@ -262,7 +262,7 @@ public function initialize();
      *
      * @param mixed $request The request to handle
      *
-     * @return FormInterface The form instance
+     * @return $this
      */
     public function handleRequest($request = null);
 
@@ -274,7 +274,7 @@ public function handleRequest($request = null);
      *                                         when they are missing in the
      *                                         submitted data.
      *
-     * @return FormInterface The form instance
+     * @return $this
      *
      * @throws Exception\AlreadySubmittedException If the form has already been submitted.
      */
@@ -283,7 +283,7 @@ public function submit($submittedData, $clearMissing = true);
     /**
      * Returns the root of the form tree.
      *
-     * @return FormInterface The root of the tree
+     * @return self The root of the tree
      */
     public function getRoot();
 

FormView.php

@@ -81,7 +81,7 @@ public function isRendered()
     /**
      * Marks the view as rendered.
      *
-     * @return FormView The view object
+     * @return $this
      */
     public function setRendered()
     {
@@ -95,7 +95,7 @@ public function setRendered()
      *
      * @param string $name The child name
      *
-     * @return FormView The child view
+     * @return self The child view
      */
     public function offsetGet($name)
     {

Guess/Guess.php

@@ -70,7 +70,7 @@ abstract class Guess
      *
      * @param Guess[] $guesses An array of guesses
      *
-     * @return Guess|null The guess with the highest confidence
+     * @return self|null
      */
     public static function getBestGuess(array $guesses)
     {

SubmitButton.php

@@ -37,7 +37,7 @@ public function isClicked()
      * @param null|string $submittedData The data
      * @param bool        $clearMissing  Not used
      *
-     * @return SubmitButton The button instance
+     * @return $this
      *
      * @throws Exception\AlreadySubmittedException If the form has already been submitted.
      */