fixed @return when returning this or static

fabpot · fabpot · commit cb06658def8e · 2016-12-27T08:23:47.000+01:00
diff --git a/OptionsResolver.php b/OptionsResolver.php
@@ -152,7 +152,7 @@ class OptionsResolver implements Options, OptionsResolverInterface
      * @param string $option The name of the option
      * @param mixed  $value  The default value of the option
      *
-     * @return OptionsResolver This instance
+     * @return $this
      *
      * @throws AccessException If called from a lazy option or normalizer
      */
@@ -215,7 +215,7 @@ public function setDefault($option, $value)
      *
      * @param array $defaults The default values to set
      *
-     * @return OptionsResolver This instance
+     * @return $this
      *
      * @throws AccessException If called from a lazy option or normalizer
      */
@@ -248,7 +248,7 @@ public function hasDefault($option)
      *
      * @param string|string[] $optionNames One or more option names
      *
-     * @return OptionsResolver This instance
+     * @return $this
      *
      * @throws AccessException If called from a lazy option or normalizer
      */
@@ -329,7 +329,7 @@ public function getMissingOptions()
      *
      * @param string|string[] $optionNames One or more option names
      *
-     * @return OptionsResolver This instance
+     * @return $this
      *
      * @throws AccessException If called from a lazy option or normalizer
      */
@@ -396,7 +396,7 @@ public function getDefinedOptions()
      * @param string   $option     The option name
      * @param \Closure $normalizer The normalizer
      *
-     * @return OptionsResolver This instance
+     * @return $this
      *
      * @throws UndefinedOptionsException If the option is undefined
      * @throws AccessException           If called from a lazy option or normalizer
@@ -428,7 +428,7 @@ public function setNormalizer($option, \Closure $normalizer)
      *
      * @param array $normalizers An array of closures
      *
-     * @return OptionsResolver This instance
+     * @return $this
      *
      * @throws UndefinedOptionsException If the option is undefined
      * @throws AccessException           If called from a lazy option or normalizer
@@ -463,7 +463,7 @@ public function setNormalizers(array $normalizers)
      * @param string $option        The option name
      * @param mixed  $allowedValues One or more acceptable values/closures
      *
-     * @return OptionsResolver This instance
+     * @return $this
      *
      * @throws UndefinedOptionsException If the option is undefined
      * @throws AccessException           If called from a lazy option or normalizer
@@ -519,7 +519,7 @@ public function setAllowedValues($option, $allowedValues = null)
      * @param string $option        The option name
      * @param mixed  $allowedValues One or more acceptable values/closures
      *
-     * @return OptionsResolver This instance
+     * @return $this
      *
      * @throws UndefinedOptionsException If the option is undefined
      * @throws AccessException           If called from a lazy option or normalizer
@@ -575,7 +575,7 @@ public function addAllowedValues($option, $allowedValues = null)
      * @param string          $option       The option name
      * @param string|string[] $allowedTypes One or more accepted types
      *
-     * @return OptionsResolver This instance
+     * @return $this
      *
      * @throws UndefinedOptionsException If the option is undefined
      * @throws AccessException           If called from a lazy option or normalizer
@@ -625,7 +625,7 @@ public function setAllowedTypes($option, $allowedTypes = null)
      * @param string          $option       The option name
      * @param string|string[] $allowedTypes One or more accepted types
      *
-     * @return OptionsResolver This instance
+     * @return $this
      *
      * @throws UndefinedOptionsException If the option is undefined
      * @throws AccessException           If called from a lazy option or normalizer
@@ -674,7 +674,7 @@ public function addAllowedTypes($option, $allowedTypes = null)
      *
      * @param string|string[] $optionNames One or more option names
      *
-     * @return OptionsResolver This instance
+     * @return $this
      *
      * @throws AccessException If called from a lazy option or normalizer
      */
@@ -695,7 +695,7 @@ public function remove($optionNames)
     /**
      * Removes all options.
      *
-     * @return OptionsResolver This instance
+     * @return $this
      *
      * @throws AccessException If called from a lazy option or normalizer
      */
diff --git a/OptionsResolverInterface.php b/OptionsResolverInterface.php
@@ -43,7 +43,7 @@ interface OptionsResolverInterface
      * @param array $defaultValues A list of option names as keys and default
      *                             values or closures as values.
      *
-     * @return OptionsResolverInterface The resolver instance
+     * @return $this
      */
     public function setDefaults(array $defaultValues);
 
@@ -58,7 +58,7 @@ public function setDefaults(array $defaultValues);
      * @param array $defaultValues A list of option names as keys and default
      *                             values or closures as values.
      *
-     * @return OptionsResolverInterface The resolver instance
+     * @return $this
      */
     public function replaceDefaults(array $defaultValues);
 
@@ -73,7 +73,7 @@ public function replaceDefaults(array $defaultValues);
      *
      * @param array $optionNames A list of option names
      *
-     * @return OptionsResolverInterface The resolver instance
+     * @return $this
      */
     public function setOptional(array $optionNames);
 
@@ -85,7 +85,7 @@ public function setOptional(array $optionNames);
      *
      * @param array $optionNames A list of option names
      *
-     * @return OptionsResolverInterface The resolver instance
+     * @return $this
      */
     public function setRequired($optionNames);
 
@@ -96,7 +96,7 @@ public function setRequired($optionNames);
      *                             with values acceptable for that option as
      *                             values.
      *
-     * @return OptionsResolverInterface The resolver instance
+     * @return $this
      *
      * @throws InvalidOptionsException If an option has not been defined
      *                                 (see {@link isKnown()}) for which
@@ -113,7 +113,7 @@ public function setAllowedValues($allowedValues);
      *                             with values acceptable for that option as
      *                             values.
      *
-     * @return OptionsResolverInterface The resolver instance
+     * @return $this
      *
      * @throws InvalidOptionsException If an option has not been defined
      *                                 (see {@link isKnown()}) for which
@@ -127,7 +127,7 @@ public function addAllowedValues($allowedValues);
      * @param array $allowedTypes A list of option names as keys and type
      *                            names passed as string or array as values.
      *
-     * @return OptionsResolverInterface The resolver instance
+     * @return $this
      *
      * @throws InvalidOptionsException If an option has not been defined for
      *                                 which an allowed type is set.
@@ -142,7 +142,7 @@ public function setAllowedTypes($allowedTypes);
      * @param array $allowedTypes A list of option names as keys and type
      *                            names passed as string or array as values.
      *
-     * @return OptionsResolverInterface The resolver instance
+     * @return $this
      *
      * @throws InvalidOptionsException If an option has not been defined for
      *                                 which an allowed type is set.
@@ -165,7 +165,7 @@ public function addAllowedTypes($allowedTypes);
      *
      * @param array $normalizers An array of closures
      *
-     * @return OptionsResolverInterface The resolver instance
+     * @return $this
      */
     public function setNormalizers(array $normalizers);
 

Original file line number	Diff line number	Diff line change
`@@ -152,7 +152,7 @@ class OptionsResolver implements Options, OptionsResolverInterface`
`152`	`152`	`* @param string $option The name of the option`
`153`	`153`	`* @param mixed $value The default value of the option`
`154`	`154`	`*`
`155`		`- * @return OptionsResolver This instance`
	`155`	`+ * @return $this`
`156`	`156`	`*`
`157`	`157`	`* @throws AccessException If called from a lazy option or normalizer`
`158`	`158`	`*/`
`@@ -215,7 +215,7 @@ public function setDefault($option, $value)`
`215`	`215`	`*`
`216`	`216`	`* @param array $defaults The default values to set`
`217`	`217`	`*`
`218`		`- * @return OptionsResolver This instance`
	`218`	`+ * @return $this`
`219`	`219`	`*`
`220`	`220`	`* @throws AccessException If called from a lazy option or normalizer`
`221`	`221`	`*/`
`@@ -248,7 +248,7 @@ public function hasDefault($option)`
`248`	`248`	`*`
`249`	`249`	`* @param string\|string[] $optionNames One or more option names`
`250`	`250`	`*`
`251`		`- * @return OptionsResolver This instance`
	`251`	`+ * @return $this`
`252`	`252`	`*`
`253`	`253`	`* @throws AccessException If called from a lazy option or normalizer`
`254`	`254`	`*/`
`@@ -329,7 +329,7 @@ public function getMissingOptions()`
`329`	`329`	`*`
`330`	`330`	`* @param string\|string[] $optionNames One or more option names`
`331`	`331`	`*`
`332`		`- * @return OptionsResolver This instance`
	`332`	`+ * @return $this`
`333`	`333`	`*`
`334`	`334`	`* @throws AccessException If called from a lazy option or normalizer`
`335`	`335`	`*/`
`@@ -396,7 +396,7 @@ public function getDefinedOptions()`
`396`	`396`	`* @param string $option The option name`
`397`	`397`	`* @param \Closure $normalizer The normalizer`
`398`	`398`	`*`
`399`		`- * @return OptionsResolver This instance`
	`399`	`+ * @return $this`
`400`	`400`	`*`
`401`	`401`	`* @throws UndefinedOptionsException If the option is undefined`
`402`	`402`	`* @throws AccessException If called from a lazy option or normalizer`
`@@ -428,7 +428,7 @@ public function setNormalizer($option, \Closure $normalizer)`
`428`	`428`	`*`
`429`	`429`	`* @param array $normalizers An array of closures`
`430`	`430`	`*`
`431`		`- * @return OptionsResolver This instance`
	`431`	`+ * @return $this`
`432`	`432`	`*`
`433`	`433`	`* @throws UndefinedOptionsException If the option is undefined`
`434`	`434`	`* @throws AccessException If called from a lazy option or normalizer`
`@@ -463,7 +463,7 @@ public function setNormalizers(array $normalizers)`
`463`	`463`	`* @param string $option The option name`
`464`	`464`	`* @param mixed $allowedValues One or more acceptable values/closures`
`465`	`465`	`*`
`466`		`- * @return OptionsResolver This instance`
	`466`	`+ * @return $this`
`467`	`467`	`*`
`468`	`468`	`* @throws UndefinedOptionsException If the option is undefined`
`469`	`469`	`* @throws AccessException If called from a lazy option or normalizer`
`@@ -519,7 +519,7 @@ public function setAllowedValues($option, $allowedValues = null)`
`519`	`519`	`* @param string $option The option name`
`520`	`520`	`* @param mixed $allowedValues One or more acceptable values/closures`
`521`	`521`	`*`
`522`		`- * @return OptionsResolver This instance`
	`522`	`+ * @return $this`
`523`	`523`	`*`
`524`	`524`	`* @throws UndefinedOptionsException If the option is undefined`
`525`	`525`	`* @throws AccessException If called from a lazy option or normalizer`
`@@ -575,7 +575,7 @@ public function addAllowedValues($option, $allowedValues = null)`
`575`	`575`	`* @param string $option The option name`
`576`	`576`	`* @param string\|string[] $allowedTypes One or more accepted types`
`577`	`577`	`*`
`578`		`- * @return OptionsResolver This instance`
	`578`	`+ * @return $this`
`579`	`579`	`*`
`580`	`580`	`* @throws UndefinedOptionsException If the option is undefined`
`581`	`581`	`* @throws AccessException If called from a lazy option or normalizer`
`@@ -625,7 +625,7 @@ public function setAllowedTypes($option, $allowedTypes = null)`
`625`	`625`	`* @param string $option The option name`
`626`	`626`	`* @param string\|string[] $allowedTypes One or more accepted types`
`627`	`627`	`*`
`628`		`- * @return OptionsResolver This instance`
	`628`	`+ * @return $this`
`629`	`629`	`*`
`630`	`630`	`* @throws UndefinedOptionsException If the option is undefined`
`631`	`631`	`* @throws AccessException If called from a lazy option or normalizer`
`@@ -674,7 +674,7 @@ public function addAllowedTypes($option, $allowedTypes = null)`
`674`	`674`	`*`
`675`	`675`	`* @param string\|string[] $optionNames One or more option names`
`676`	`676`	`*`
`677`		`- * @return OptionsResolver This instance`
	`677`	`+ * @return $this`
`678`	`678`	`*`
`679`	`679`	`* @throws AccessException If called from a lazy option or normalizer`
`680`	`680`	`*/`
`@@ -695,7 +695,7 @@ public function remove($optionNames)`
`695`	`695`	`/**`
`696`	`696`	`* Removes all options.`
`697`	`697`	`*`
`698`		`- * @return OptionsResolver This instance`
	`698`	`+ * @return $this`
`699`	`699`	`*`
`700`	`700`	`* @throws AccessException If called from a lazy option or normalizer`
`701`	`701`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ interface OptionsResolverInterface`
`43`	`43`	`* @param array $defaultValues A list of option names as keys and default`
`44`	`44`	`* values or closures as values.`
`45`	`45`	`*`
`46`		`- * @return OptionsResolverInterface The resolver instance`
	`46`	`+ * @return $this`
`47`	`47`	`*/`
`48`	`48`	`public function setDefaults(array $defaultValues);`
`49`	`49`
`@@ -58,7 +58,7 @@ public function setDefaults(array $defaultValues);`
`58`	`58`	`* @param array $defaultValues A list of option names as keys and default`
`59`	`59`	`* values or closures as values.`
`60`	`60`	`*`
`61`		`- * @return OptionsResolverInterface The resolver instance`
	`61`	`+ * @return $this`
`62`	`62`	`*/`
`63`	`63`	`public function replaceDefaults(array $defaultValues);`
`64`	`64`
`@@ -73,7 +73,7 @@ public function replaceDefaults(array $defaultValues);`
`73`	`73`	`*`
`74`	`74`	`* @param array $optionNames A list of option names`
`75`	`75`	`*`
`76`		`- * @return OptionsResolverInterface The resolver instance`
	`76`	`+ * @return $this`
`77`	`77`	`*/`
`78`	`78`	`public function setOptional(array $optionNames);`
`79`	`79`
`@@ -85,7 +85,7 @@ public function setOptional(array $optionNames);`
`85`	`85`	`*`
`86`	`86`	`* @param array $optionNames A list of option names`
`87`	`87`	`*`
`88`		`- * @return OptionsResolverInterface The resolver instance`
	`88`	`+ * @return $this`
`89`	`89`	`*/`
`90`	`90`	`public function setRequired($optionNames);`
`91`	`91`
`@@ -96,7 +96,7 @@ public function setRequired($optionNames);`
`96`	`96`	`* with values acceptable for that option as`
`97`	`97`	`* values.`
`98`	`98`	`*`
`99`		`- * @return OptionsResolverInterface The resolver instance`
	`99`	`+ * @return $this`
`100`	`100`	`*`
`101`	`101`	`* @throws InvalidOptionsException If an option has not been defined`
`102`	`102`	`* (see {@link isKnown()}) for which`
`@@ -113,7 +113,7 @@ public function setAllowedValues($allowedValues);`
`113`	`113`	`* with values acceptable for that option as`
`114`	`114`	`* values.`
`115`	`115`	`*`
`116`		`- * @return OptionsResolverInterface The resolver instance`
	`116`	`+ * @return $this`
`117`	`117`	`*`
`118`	`118`	`* @throws InvalidOptionsException If an option has not been defined`
`119`	`119`	`* (see {@link isKnown()}) for which`
`@@ -127,7 +127,7 @@ public function addAllowedValues($allowedValues);`
`127`	`127`	`* @param array $allowedTypes A list of option names as keys and type`
`128`	`128`	`* names passed as string or array as values.`
`129`	`129`	`*`
`130`		`- * @return OptionsResolverInterface The resolver instance`
	`130`	`+ * @return $this`
`131`	`131`	`*`
`132`	`132`	`* @throws InvalidOptionsException If an option has not been defined for`
`133`	`133`	`* which an allowed type is set.`
`@@ -142,7 +142,7 @@ public function setAllowedTypes($allowedTypes);`
`142`	`142`	`* @param array $allowedTypes A list of option names as keys and type`
`143`	`143`	`* names passed as string or array as values.`
`144`	`144`	`*`
`145`		`- * @return OptionsResolverInterface The resolver instance`
	`145`	`+ * @return $this`
`146`	`146`	`*`
`147`	`147`	`* @throws InvalidOptionsException If an option has not been defined for`
`148`	`148`	`* which an allowed type is set.`
`@@ -165,7 +165,7 @@ public function addAllowedTypes($allowedTypes);`
`165`	`165`	`*`
`166`	`166`	`* @param array $normalizers An array of closures`
`167`	`167`	`*`
`168`		`- * @return OptionsResolverInterface The resolver instance`
	`168`	`+ * @return $this`
`169`	`169`	`*/`
`170`	`170`	`public function setNormalizers(array $normalizers);`
`171`	`171`