Docblock fixes

Author: GrahamCampbell

Collator/Collator.php

@@ -72,7 +72,7 @@ class Collator
      *
      * @param string $locale The locale code. The only currently supported locale is "en".
      *
-     * @throws MethodArgumentValueNotImplementedException  When $locale different than "en" is passed
+     * @throws MethodArgumentValueNotImplementedException When $locale different than "en" is passed
      */
     public function __construct($locale)
     {
@@ -88,7 +88,7 @@ public function __construct($locale)
      *
      * @return Collator
      *
-     * @throws MethodArgumentValueNotImplementedException  When $locale different than "en" is passed
+     * @throws MethodArgumentValueNotImplementedException When $locale different than "en" is passed
      */
     public static function create($locale)
     {
@@ -98,13 +98,13 @@ public static function create($locale)
     /**
      * Sort array maintaining index association
      *
-     * @param array   &$array    Input array
-     * @param int     $sortFlag  Flags for sorting, can be one of the following:
-     *                           Collator::SORT_REGULAR - compare items normally (don't change types)
-     *                           Collator::SORT_NUMERIC - compare items numerically
-     *                           Collator::SORT_STRING - compare items as strings
+     * @param array &$array   Input array
+     * @param int   $sortFlag Flags for sorting, can be one of the following:
+     *                        Collator::SORT_REGULAR - compare items normally (don't change types)
+     *                        Collator::SORT_NUMERIC - compare items numerically
+     *                        Collator::SORT_STRING - compare items as strings
      *
-     * @return bool    True on success or false on failure
+     * @return bool True on success or false on failure
      */
     public function asort(&$array, $sortFlag = self::SORT_REGULAR)
     {
@@ -125,10 +125,10 @@ public function asort(&$array, $sortFlag = self::SORT_REGULAR)
      * @param string $str1 The first string to compare
      * @param string $str2 The second string to compare
      *
-     * @return bool|int        Return the comparison result or false on failure:
-     *                         1 if $str1 is greater than $str2
-     *                         0 if $str1 is equal than $str2
-     *                         -1 if $str1 is less than $str2
+     * @return bool|int Return the comparison result or false on failure:
+     *                  1 if $str1 is greater than $str2
+     *                  0 if $str1 is equal than $str2
+     *                  -1 if $str1 is less than $str2
      *
      * @see http://www.php.net/manual/en/collator.compare.php
      *
@@ -144,7 +144,7 @@ public function compare($str1, $str2)
      *
      * @param int $attr An attribute specifier, one of the attribute constants
      *
-     * @return bool|int      The attribute value on success or false on error
+     * @return bool|int The attribute value on success or false on error
      *
      * @see http://www.php.net/manual/en/collator.getattribute.php
      *
@@ -207,7 +207,7 @@ public function getSortKey($string)
     /**
      * Not supported. Get current collator's strength
      *
-     * @return bool|int      The current collator's strength or false on failure
+     * @return bool|int The current collator's strength or false on failure
      *
      * @see http://www.php.net/manual/en/collator.getstrength.php
      *
@@ -224,7 +224,7 @@ public function getStrength()
      * @param int $attr An attribute specifier, one of the attribute constants
      * @param int $val  The attribute value, one of the attribute value constants
      *
-     * @return bool    True on success or false on failure
+     * @return bool True on success or false on failure
      *
      * @see http://www.php.net/manual/en/collator.setattribute.php
      *
@@ -239,14 +239,14 @@ public function setAttribute($attr, $val)
      * Not supported. Set the collator's strength
      *
      * @param int $strength Strength to set, possible values:
-     *                           Collator::PRIMARY
-     *                           Collator::SECONDARY
-     *                           Collator::TERTIARY
-     *                           Collator::QUATERNARY
-     *                           Collator::IDENTICAL
-     *                           Collator::DEFAULT
+     *                      Collator::PRIMARY
+     *                      Collator::SECONDARY
+     *                      Collator::TERTIARY
+     *                      Collator::QUATERNARY
+     *                      Collator::IDENTICAL
+     *                      Collator::DEFAULT
      *
-     * @return bool    True on success or false on failure
+     * @return bool True on success or false on failure
      *
      * @see http://www.php.net/manual/en/collator.setstrength.php
      *
@@ -260,9 +260,9 @@ public function setStrength($strength)
     /**
      * Not supported. Sort array using specified collator and sort keys
      *
-     * @param  array   &$arr   Array of strings to sort
+     * @param array &$arr Array of strings to sort
      *
-     * @return bool    True on success or false on failure
+     * @return bool True on success or false on failure
      *
      * @see http://www.php.net/manual/en/collator.sortwithsortkeys.php
      *
@@ -276,13 +276,13 @@ public function sortWithSortKeys(&$arr)
     /**
      * Not supported. Sort array using specified collator
      *
-     * @param  array   &$arr       Array of string to sort
-     * @param int $sortFlag Optional sorting type, one of the following:
-     *                             Collator::SORT_REGULAR
-     *                             Collator::SORT_NUMERIC
-     *                             Collator::SORT_STRING
+     * @param array &$arr     Array of string to sort
+     * @param int   $sortFlag Optional sorting type, one of the following:
+     *                        Collator::SORT_REGULAR
+     *                        Collator::SORT_NUMERIC
+     *                        Collator::SORT_STRING
      *
-     * @return bool    True on success or false on failure
+     * @return bool True on success or false on failure
      *
      * @see http://www.php.net/manual/en/collator.sort.php
      *

Data/Bundle/Writer/TextBundleWriter.php

@@ -151,8 +151,8 @@ private function writeIntVector($file, array $value, $indentation)
     /**
      * Writes a "string" node.
      *
-     * @param resource $file         The file handle to write to.
-     * @param string   $value        The value of the node.
+     * @param resource $file          The file handle to write to.
+     * @param string   $value         The value of the node.
      * @param bool     $requireBraces Whether to require braces to be printed
      *                                around the value.
      *

DateFormatter/DateFormat/FullTransformer.php

@@ -84,7 +84,7 @@ public function getTransformers()
      *
      * @param \DateTime $dateTime A DateTime object to be used to generate the formatted value
      *
-     * @return string               The formatted value
+     * @return string The formatted value
      */
     public function format(\DateTime $dateTime)
     {
@@ -103,9 +103,9 @@ public function format(\DateTime $dateTime)
      * @param string    $dateChars The date characters to be replaced with a formatted ICU value
      * @param \DateTime $dateTime  A DateTime object to be used to generate the formatted value
      *
-     * @return string                   The formatted value
+     * @return string The formatted value
      *
-     * @throws NotImplementedException  When it encounters a not implemented date character
+     * @throws NotImplementedException When it encounters a not implemented date character
      */
     public function formatReplace($dateChars, $dateTime)
     {
@@ -131,11 +131,11 @@ public function formatReplace($dateChars, $dateTime)
      * Parse a pattern based string to a timestamp value
      *
      * @param \DateTime $dateTime A configured DateTime object to use to perform the date calculation
-     * @param string   $value    String to convert to a time value
+     * @param string    $value    String to convert to a time value
      *
-     * @return int                       The corresponding Unix timestamp
+     * @return int The corresponding Unix timestamp
      *
-     * @throws \InvalidArgumentException  When the value can not be matched with pattern
+     * @throws \InvalidArgumentException When the value can not be matched with pattern
      */
     public function parse(\DateTime $dateTime, $value)
     {
@@ -171,8 +171,8 @@ public function parse(\DateTime $dateTime, $value)
      *
      * @param string $pattern The pattern to create the reverse matching regular expression
      *
-     * @return string            The reverse matching regular expression with named captures being formed by the
-     *                           transformer index in the $transformer array
+     * @return string The reverse matching regular expression with named captures being formed by the
+     *                transformer index in the $transformer array
      */
     public function getReverseMatchingRegExp($pattern)
     {
@@ -210,7 +210,7 @@ public function getReverseMatchingRegExp($pattern)
      *
      * @param string $quoteMatch The string to check
      *
-     * @return bool                 true if matches, false otherwise
+     * @return bool true if matches, false otherwise
      */
     public function isQuoteMatch($quoteMatch)
     {
@@ -222,7 +222,7 @@ public function isQuoteMatch($quoteMatch)
      *
      * @param string $quoteMatch The string to replace the quotes
      *
-     * @return string               A string with the single quotes replaced
+     * @return string A string with the single quotes replaced
      */
     public function replaceQuoteMatch($quoteMatch)
     {
@@ -238,7 +238,7 @@ public function replaceQuoteMatch($quoteMatch)
      *
      * @param string $specialChars A string of chars to build the regular expression
      *
-     * @return string                 The chars match regular expression
+     * @return string The chars match regular expression
      */
     protected function buildCharsMatch($specialChars)
     {
@@ -284,7 +284,7 @@ protected function normalizeArray(array $data)
      * @param \DateTime $dateTime The DateTime object to be used to calculate the timestamp
      * @param array     $options  An array with the matched values to be used to calculate the timestamp
      *
-     * @return bool|int           The calculated timestamp or false if matched date is invalid
+     * @return bool|int The calculated timestamp or false if matched date is invalid
      */
     protected function calculateUnixTimestamp(\DateTime $dateTime, array $options)
     {

DateFormatter/DateFormat/HourTransformer.php

@@ -24,7 +24,7 @@ abstract class HourTransformer extends Transformer
      * @param int    $hour   The hour value
      * @param string $marker An optional AM/PM marker
      *
-     * @return int              The normalized hour value
+     * @return int The normalized hour value
      */
     abstract public function normalizeHour($hour, $marker = null);
 }

DateFormatter/DateFormat/TimeZoneTransformer.php

@@ -23,7 +23,7 @@ class TimeZoneTransformer extends Transformer
     /**
      * {@inheritdoc}
      *
-     * @throws NotImplementedException  When time zone is different than UTC or GMT (Etc/GMT)
+     * @throws NotImplementedException When time zone is different than UTC or GMT (Etc/GMT)
      */
     public function format(\DateTime $dateTime, $length)
     {
@@ -69,13 +69,13 @@ public function extractDateOptions($matched, $length)
      *
      * @param string $formattedTimeZone A GMT timezone string (GMT-03:00, e.g.)
      *
-     * @return string                     A timezone identifier
+     * @return string A timezone identifier
      *
      * @see    http://php.net/manual/en/timezones.others.php
      * @see    http://www.twinsun.com/tz/tz-link.htm
      *
      * @throws NotImplementedException   When the GMT time zone have minutes offset different than zero
-     * @throws \InvalidArgumentException  When the value can not be matched with pattern
+     * @throws \InvalidArgumentException When the value can not be matched with pattern
      */
     public static function getEtcTimeZoneId($formattedTimeZone)
     {

DateFormatter/DateFormat/Transformer.php

@@ -25,7 +25,7 @@ abstract class Transformer
      * @param \DateTime $dateTime A DateTime object to be used to generate the formatted value
      * @param int       $length   The formatted value string length
      *
-     * @return string               The formatted value
+     * @return string The formatted value
      */
     abstract public function format(\DateTime $dateTime, $length);
 
@@ -34,7 +34,7 @@ abstract public function format(\DateTime $dateTime, $length);
      *
      * @param int $length The length of the value to be reverse matched
      *
-     * @return string           The reverse matching regular expression
+     * @return string The reverse matching regular expression
      */
     abstract public function getReverseMatchingRegExp($length);
 
@@ -45,7 +45,7 @@ abstract public function getReverseMatchingRegExp($length);
      * @param string $matched The matched value
      * @param int    $length  The length of the Transformer pattern string
      *
-     * @return array             An associative array
+     * @return array An associative array
      */
     abstract public function extractDateOptions($matched, $length);
 
@@ -55,7 +55,7 @@ abstract public function extractDateOptions($matched, $length);
      * @param string $value  The string to be padded
      * @param int    $length The length to pad
      *
-     * @return string           The padded string
+     * @return string The padded string
      */
     protected function padLeft($value, $length)
     {