PHPOffice / PhpSpreadsheet

src/PhpSpreadsheet/Calculation/DateTime.php

Doc Comments +18 added lines, -26 removed lines

@@ -460,7 +460,7 @@ 
      *        DATEVALUE(dateValue)
      *
      * @category Date/Time Functions
-     * @param    string    $dateValue        Text that represents a date in a Microsoft Excel date format.
+     * @param    integer    $dateValue        Text that represents a date in a Microsoft Excel date format.
      *                                    For example, "1/30/2008" or "30-Jan-2008" are text strings within
      *                                    quotation marks that represent dates. Using the default date
      *                                    system in Excel for Windows, date_text must represent a date from
@@ -644,9 +644,9 @@ 
     /**
      * DATEDIF
      *
-     * @param    mixed    $startDate        Excel date serial value, PHP date/time stamp, PHP DateTime object
+     * @param    integer    $startDate        Excel date serial value, PHP date/time stamp, PHP DateTime object
      *                                    or a standard date string
-     * @param    mixed    $endDate        Excel date serial value, PHP date/time stamp, PHP DateTime object
+     * @param    integer    $endDate        Excel date serial value, PHP date/time stamp, PHP DateTime object
      *                                    or a standard date string
      * @param    string    $unit
      * @return    int    Interval between the dates
@@ -757,9 +757,9 @@ 
      *        DAYS360(startDate,endDate[,method])
      *
      * @category Date/Time Functions
-     * @param    mixed        $startDate        Excel date serial value (float), PHP date timestamp (integer),
+     * @param    integer        $startDate        Excel date serial value (float), PHP date timestamp (integer),
      *                                        PHP DateTime object, or a standard date string
-     * @param    mixed        $endDate        Excel date serial value (float), PHP date timestamp (integer),
+     * @param    integer        $endDate        Excel date serial value (float), PHP date timestamp (integer),
      *                                        PHP DateTime object, or a standard date string
      * @param    bool        $method            US or European Method
      *                                        FALSE or omitted: U.S. (NASD) method. If the starting date is
@@ -816,9 +816,9 @@ 
      *        YEARFRAC(startDate,endDate[,method])
      *
      * @category Date/Time Functions
-     * @param    mixed    $startDate        Excel date serial value (float), PHP date timestamp (integer),
+     * @param    integer    $startDate        Excel date serial value (float), PHP date timestamp (integer),
      *                                    PHP DateTime object, or a standard date string
-     * @param    mixed    $endDate        Excel date serial value (float), PHP date timestamp (integer),
+     * @param    integer    $endDate        Excel date serial value (float), PHP date timestamp (integer),
      *                                    PHP DateTime object, or a standard date string
      * @param    int    $method            Method used for the calculation
      *                                        0 or omitted    US (NASD) 30/360
@@ -918,10 +918,6 @@ 
      *                                            PHP DateTime object, or a standard date string
      * @param    mixed            $endDate        Excel date serial value (float), PHP date timestamp (integer),
      *                                            PHP DateTime object, or a standard date string
-     * @param    mixed            $holidays,...    Optional series of Excel date serial value (float), PHP date
-     *                                            timestamp (integer), PHP DateTime object, or a standard date
-     *                                            strings that will be excluded from the working calendar, such
-     *                                            as state and federal holidays and floating holidays.
      * @return    int            Interval between the dates
      */
     public static function NETWORKDAYS($startDate, $endDate)
@@ -1003,10 +999,6 @@ 
      * @param    int        $endDays        The number of nonweekend and nonholiday days before or after
      *                                        startDate. A positive value for days yields a future date; a
      *                                        negative value yields a past date.
-     * @param    mixed        $holidays,...    Optional series of Excel date serial value (float), PHP date
-     *                                        timestamp (integer), PHP DateTime object, or a standard date
-     *                                        strings that will be excluded from the working calendar, such
-     *                                        as state and federal holidays and floating holidays.
      * @return    mixed    Excel date/time serial value, PHP date/time serial value or PHP date/time object,
      *                        depending on the value of the ReturnDateType flag
      */
@@ -1110,7 +1102,7 @@ 
      * Excel Function:
      *        DAY(dateValue)
      *
-     * @param    mixed    $dateValue        Excel date serial value (float), PHP date timestamp (integer),
+     * @param    integer    $dateValue        Excel date serial value (float), PHP date timestamp (integer),
      *                                    PHP DateTime object, or a standard date string
      * @return    int        Day of the month
      */
@@ -1143,7 +1135,7 @@ 
      * Excel Function:
      *        WEEKDAY(dateValue[,style])
      *
-     * @param    mixed    $dateValue        Excel date serial value (float), PHP date timestamp (integer),
+     * @param    integer    $dateValue        Excel date serial value (float), PHP date timestamp (integer),
      *                                    PHP DateTime object, or a standard date string
      * @param    int        $style            A number that determines the type of return value
      *                                        1 or omitted    Numbers 1 (Sunday) through 7 (Saturday).
@@ -1219,9 +1211,9 @@ 
      * Excel Function:
      *        WEEKNUM(dateValue[,style])
      *
-     * @param    mixed    $dateValue        Excel date serial value (float), PHP date timestamp (integer),
+     * @param    integer    $dateValue        Excel date serial value (float), PHP date timestamp (integer),
      *                                    PHP DateTime object, or a standard date string
-     * @param    bool    $method            Week begins on Sunday or Monday
+     * @param    integer    $method            Week begins on Sunday or Monday
      *                                        1 or omitted    Week begins on Sunday.
      *                                        2                Week begins on Monday.
      * @return    int        Week Number
@@ -1267,7 +1259,7 @@ 
      * Excel Function:
      *        MONTH(dateValue)
      *
-     * @param    mixed    $dateValue        Excel date serial value (float), PHP date timestamp (integer),
+     * @param    integer    $dateValue        Excel date serial value (float), PHP date timestamp (integer),
      *                                    PHP DateTime object, or a standard date string
      * @return    int        Month of the year
      */
@@ -1299,7 +1291,7 @@ 
      * Excel Function:
      *        YEAR(dateValue)
      *
-     * @param    mixed    $dateValue        Excel date serial value (float), PHP date timestamp (integer),
+     * @param    integer    $dateValue        Excel date serial value (float), PHP date timestamp (integer),
      *                                    PHP DateTime object, or a standard date string
      * @return    int        Year
      */
@@ -1330,7 +1322,7 @@ 
      * Excel Function:
      *        HOUR(timeValue)
      *
-     * @param    mixed    $timeValue        Excel date serial value (float), PHP date timestamp (integer),
+     * @param    integer    $timeValue        Excel date serial value (float), PHP date timestamp (integer),
      *                                    PHP DateTime object, or a standard time string
      * @return    int        Hour
      */
@@ -1370,7 +1362,7 @@ 
      * Excel Function:
      *        MINUTE(timeValue)
      *
-     * @param    mixed    $timeValue        Excel date serial value (float), PHP date timestamp (integer),
+     * @param    integer    $timeValue        Excel date serial value (float), PHP date timestamp (integer),
      *                                    PHP DateTime object, or a standard time string
      * @return    int        Minute
      */
@@ -1410,7 +1402,7 @@ 
      * Excel Function:
      *        SECOND(timeValue)
      *
-     * @param    mixed    $timeValue        Excel date serial value (float), PHP date timestamp (integer),
+     * @param    integer    $timeValue        Excel date serial value (float), PHP date timestamp (integer),
      *                                    PHP DateTime object, or a standard time string
      * @return    int        Second
      */
@@ -1452,7 +1444,7 @@ 
      * Excel Function:
      *        EDATE(dateValue,adjustmentMonths)
      *
-     * @param    mixed    $dateValue            Excel date serial value (float), PHP date timestamp (integer),
+     * @param    integer    $dateValue            Excel date serial value (float), PHP date timestamp (integer),
      *                                        PHP DateTime object, or a standard date string
      * @param    int        $adjustmentMonths    The number of months before or after start_date.
      *                                        A positive value for months yields a future date;
@@ -1497,7 +1489,7 @@ 
      * Excel Function:
      *        EOMONTH(dateValue,adjustmentMonths)
      *
-     * @param    mixed    $dateValue            Excel date serial value (float), PHP date timestamp (integer),
+     * @param    integer    $dateValue            Excel date serial value (float), PHP date timestamp (integer),
      *                                        PHP DateTime object, or a standard date string
      * @param    int        $adjustmentMonths    The number of months before or after start_date.
      *                                        A positive value for months yields a future date;

Spacing +3 added lines, -3 removed lines

@@ -424,7 +424,7 @@ 
 
                 return (float) \PhpSpreadsheet\Shared\Date::formattedPHPToExcel($calendar, 1, $date, $hour, $minute, $second);
             case Functions::RETURNDATE_PHP_NUMERIC:
-                return (integer) \PhpSpreadsheet\Shared\Date::excelToTimestamp(\PhpSpreadsheet\Shared\Date::formattedPHPToExcel(1970, 1, 1, $hour, $minute, $second));    // -2147468400; //    -2147472000 + 3600
+                return (integer) \PhpSpreadsheet\Shared\Date::excelToTimestamp(\PhpSpreadsheet\Shared\Date::formattedPHPToExcel(1970, 1, 1, $hour, $minute, $second)); // -2147468400; //    -2147472000 + 3600
             case Functions::RETURNDATE_PHP_OBJECT:
                 $dayAdjust = 0;
                 if ($hour < 0) {
@@ -1036,7 +1036,7 @@ 
 
         $startDoW = self::DAYOFWEEK($startDate, 3);
         if (self::DAYOFWEEK($startDate, 3) >= 5) {
-            $startDate += ($decrementing) ? -$startDoW + 4: 7 - $startDoW;
+            $startDate += ($decrementing) ? -$startDoW + 4 : 7 - $startDoW;
             ($decrementing) ? $endDays++ : $endDays--;
         }
 
@@ -1046,7 +1046,7 @@ 
         //    Adjust the calculated end date if it falls over a weekend
         $endDoW = self::DAYOFWEEK($endDate, 3);
         if ($endDoW >= 5) {
-            $endDate += ($decrementing) ? -$endDoW + 4: 7 - $endDoW;
+            $endDate += ($decrementing) ? -$endDoW + 4 : 7 - $endDoW;
         }
 
         //    Test any extra holiday parameters

src/PhpSpreadsheet/Calculation/Functions.php

Doc Comments +2 added lines, -2 removed lines

@@ -384,7 +384,7 @@ 
      * IS_EVEN
      *
      * @param    mixed $value Value to check
-     * @return    bool
+     * @return    string|boolean
      */
     public static function isEven($value = null)
     {
@@ -403,7 +403,7 @@ 
      * IS_ODD
      *
      * @param    mixed $value Value to check
-     * @return    bool
+     * @return    string|boolean
      */
     public static function isOdd($value = null)
     {

src/PhpSpreadsheet/Calculation/Logical.php

Doc Comments +5 added lines, -7 removed lines

@@ -75,8 +75,7 @@ 
      *            the value TRUE or FALSE, in which case it is evaluated as the corresponding boolean value
      *
      * @category Logical Functions
-     * @param    mixed        $arg,...        Data values
-     * @return    bool        The logical AND of the arguments.
+     * @return    string|boolean        The logical AND of the arguments.
      */
     public static function logicalAnd()
     {
@@ -130,8 +129,7 @@ 
      *            the value TRUE or FALSE, in which case it is evaluated as the corresponding boolean value
      *
      * @category Logical Functions
-     * @param    mixed        $arg,...        Data values
-     * @return    bool        The logical OR of the arguments.
+     * @return    string|boolean        The logical OR of the arguments.
      */
     public static function logicalOr()
     {
@@ -185,7 +183,7 @@ 
      *
      * @category Logical Functions
      * @param    mixed        $logical    A value or expression that can be evaluated to TRUE or FALSE
-     * @return    bool        The boolean inverse of the argument.
+     * @return    boolean|string        The boolean inverse of the argument.
      */
     public static function NOT($logical = false)
     {
@@ -230,8 +228,8 @@ 
      *            ReturnIfFalse can be another formula.
      *
      * @category Logical Functions
-     * @param    mixed    $condition        Condition to evaluate
-     * @param    mixed    $returnIfTrue    Value to return when condition is true
+     * @param    boolean    $condition        Condition to evaluate
+     * @param    integer    $returnIfTrue    Value to return when condition is true
      * @param    mixed    $returnIfFalse    Optional value to return when condition is false
      * @return    mixed    The value of returnIfTrue or returnIfFalse determined by condition
      */

Spacing +2 added lines, -2 removed lines

@@ -237,8 +237,8 @@
      */
     public static function statementIf($condition = true, $returnIfTrue = 0, $returnIfFalse = false)
     {
-        $condition = (is_null($condition))     ? true :  (boolean) Functions::flattenSingleValue($condition);
-        $returnIfTrue = (is_null($returnIfTrue))  ? 0 :     Functions::flattenSingleValue($returnIfTrue);
+        $condition = (is_null($condition)) ? true : (boolean) Functions::flattenSingleValue($condition);
+        $returnIfTrue = (is_null($returnIfTrue)) ? 0 : Functions::flattenSingleValue($returnIfTrue);
         $returnIfFalse = (is_null($returnIfFalse)) ? false : Functions::flattenSingleValue($returnIfFalse);
 
         return ($condition) ? $returnIfTrue : $returnIfFalse;

src/PhpSpreadsheet/Calculation/Statistical.php

Doc Comments +6 added lines, -44 removed lines

@@ -124,7 +124,7 @@ 
      *
      * @param p require p>0
      * @param q require q>0
-     * @return 0 if p<=0, q<=0 or p+q>2.55E305 to avoid errors and over/underflow
+     * @return double if p<=0, q<=0 or p+q>2.55E305 to avoid errors and over/underflow
      * @author Jaco van Kooten
      */
     private static function logBeta($p, $q)
@@ -146,6 +146,8 @@ 
      * Evaluates of continued fraction part of incomplete beta function.
      * Based on an idea from Numerical Recipes (W.H. Press et al, 1992).
      * @author Jaco van Kooten
+     * @param double $p
+     * @param double $q
      */
     private static function betaFraction($x, $p, $q)
     {
@@ -702,7 +704,6 @@ 
      *        AVEDEV(value1[,value2[, ...]])
      *
      * @category Statistical Functions
-     * @param    mixed        $arg,...        Data values
      * @return    float
      */
     public static function AVEDEV()
@@ -751,7 +752,6 @@ 
      *        AVERAGE(value1[,value2[, ...]])
      *
      * @category Statistical Functions
-     * @param    mixed        $arg,...        Data values
      * @return    float
      */
     public static function AVERAGE()
@@ -792,7 +792,6 @@ 
      *        AVERAGEA(value1[,value2[, ...]])
      *
      * @category Statistical Functions
-     * @param    mixed        $arg,...        Data values
      * @return    float
      */
     public static function AVERAGEA()
@@ -837,7 +836,6 @@ 
      *        AVERAGEIF(value1[,value2[, ...]],condition)
      *
      * @category Mathematical and Trigonometric Functions
-     * @param    mixed        $arg,...        Data values
      * @param    string        $condition        The criteria that defines which cells will be checked.
      * @param    mixed[]        $averageArgs    Data values
      * @return    float
@@ -882,7 +880,6 @@ 
      * @param    float        $value            Value at which you want to evaluate the distribution
      * @param    float        $alpha            Parameter to the distribution
      * @param    float        $beta            Parameter to the distribution
-     * @param    bool        $cumulative
      * @return    float
      */
     public static function BETADIST($value, $alpha, $beta, $rMin = 0, $rMax = 1)
@@ -919,9 +916,8 @@ 
      * @param    float        $probability    Probability at which you want to evaluate the distribution
      * @param    float        $alpha            Parameter to the distribution
      * @param    float        $beta            Parameter to the distribution
-     * @param    float        $rMin            Minimum value
-     * @param    float        $rMax            Maximum value
-     * @param    bool        $cumulative
+     * @param    integer        $rMin            Minimum value
+     * @param    integer        $rMax            Maximum value
      * @return    float
      */
     public static function BETAINV($probability, $alpha, $beta, $rMin = 0, $rMax = 1)
@@ -1172,7 +1168,6 @@ 
      *        COUNT(value1[,value2[, ...]])
      *
      * @category Statistical Functions
-     * @param    mixed        $arg,...        Data values
      * @return    int
      */
     public static function COUNT()
@@ -1204,7 +1199,6 @@ 
      *        COUNTA(value1[,value2[, ...]])
      *
      * @category Statistical Functions
-     * @param    mixed        $arg,...        Data values
      * @return    int
      */
     public static function COUNTA()
@@ -1232,7 +1226,6 @@ 
      *        COUNTBLANK(value1[,value2[, ...]])
      *
      * @category Statistical Functions
-     * @param    mixed        $arg,...        Data values
      * @return    int
      */
     public static function COUNTBLANK()
@@ -1260,7 +1253,6 @@ 
      *        COUNTIF(value1[,value2[, ...]],condition)
      *
      * @category Statistical Functions
-     * @param    mixed        $arg,...        Data values
      * @param    string        $condition        The criteria that defines which cells will be counted.
      * @return    int
      */
@@ -1445,7 +1437,6 @@ 
      *        DEVSQ(value1[,value2[, ...]])
      *
      * @category Statistical Functions
-     * @param    mixed        $arg,...        Data values
      * @return    float
      */
     public static function DEVSQ()
@@ -1727,7 +1718,6 @@ 
      *        GEOMEAN(value1[,value2[, ...]])
      *
      * @category Statistical Functions
-     * @param    mixed        $arg,...        Data values
      * @return    float
      */
     public static function GEOMEAN()
@@ -1786,7 +1776,6 @@ 
      *        HARMEAN(value1[,value2[, ...]])
      *
      * @category Statistical Functions
-     * @param    mixed        $arg,...        Data values
      * @return    float
      */
     public static function HARMEAN()
@@ -1940,8 +1929,6 @@ 
      *        LARGE(value1[,value2[, ...]],entry)
      *
      * @category Statistical Functions
-     * @param    mixed        $arg,...        Data values
-     * @param    int            $entry            Position (ordered from the largest) in the array or range of data to return
      * @return    float
      */
     public static function LARGE()
@@ -2163,7 +2150,6 @@ 
      *        MAX(value1[,value2[, ...]])
      *
      * @category Statistical Functions
-     * @param    mixed        $arg,...        Data values
      * @return    float
      */
     public static function MAX()
@@ -2197,7 +2183,6 @@ 
      *        MAXA(value1[,value2[, ...]])
      *
      * @category Statistical Functions
-     * @param    mixed        $arg,...        Data values
      * @return    float
      */
     public static function MAXA()
@@ -2236,7 +2221,6 @@ 
      *        MAXIF(value1[,value2[, ...]],condition)
      *
      * @category Mathematical and Trigonometric Functions
-     * @param    mixed        $arg,...        Data values
      * @param    string        $condition        The criteria that defines which cells will be checked.
      * @return    float
      */
@@ -2275,7 +2259,6 @@ 
      *        MEDIAN(value1[,value2[, ...]])
      *
      * @category Statistical Functions
-     * @param    mixed        $arg,...        Data values
      * @return    float
      */
     public static function MEDIAN()
@@ -2317,7 +2300,6 @@ 
      *        MIN(value1[,value2[, ...]])
      *
      * @category Statistical Functions
-     * @param    mixed        $arg,...        Data values
      * @return    float
      */
     public static function MIN()
@@ -2351,7 +2333,6 @@ 
      *        MINA(value1[,value2[, ...]])
      *
      * @category Statistical Functions
-     * @param    mixed        $arg,...        Data values
      * @return    float
      */
     public static function MINA()
@@ -2390,7 +2371,6 @@ 
      *        MINIF(value1[,value2[, ...]],condition)
      *
      * @category Mathematical and Trigonometric Functions
-     * @param    mixed        $arg,...        Data values
      * @param    string        $condition        The criteria that defines which cells will be checked.
      * @return    float
      */
@@ -2466,7 +2446,6 @@ 
      *        MODE(value1[,value2[, ...]])
      *
      * @category Statistical Functions
-     * @param    mixed        $arg,...        Data values
      * @return    float
      */
     public static function MODE()
@@ -2569,9 +2548,9 @@ 
      *
      * Returns the inverse of the normal cumulative distribution for the specified mean and standard deviation.
      *
-     * @param    float        $value
      * @param    float        $mean        Mean Value
      * @param    float        $stdDev        Standard Deviation
+     * @param double $probability
      * @return    float
      */
     public static function NORMINV($probability, $mean, $stdDev)
@@ -2633,8 +2612,6 @@ 
      *        PERCENTILE(value1[,value2[, ...]],entry)
      *
      * @category Statistical Functions
-     * @param    mixed        $arg,...        Data values
-     * @param    float        $entry            Percentile value in the range 0..1, inclusive.
      * @return    float
      */
     public static function PERCENTILE()
@@ -2798,8 +2775,6 @@ 
      *        QUARTILE(value1[,value2[, ...]],entry)
      *
      * @category Statistical Functions
-     * @param    mixed        $arg,...        Data values
-     * @param    int            $entry            Quartile value in the range 1..3, inclusive.
      * @return    float
      */
     public static function QUARTILE()
@@ -2960,8 +2935,6 @@ 
      *        SMALL(value1[,value2[, ...]],entry)
      *
      * @category Statistical Functions
-     * @param    mixed        $arg,...        Data values
-     * @param    int            $entry            Position (ordered from the smallest) in the array or range of data to return
      * @return    float
      */
     public static function SMALL()
@@ -3029,7 +3002,6 @@ 
      *        STDEV(value1[,value2[, ...]])
      *
      * @category Statistical Functions
-     * @param    mixed        $arg,...        Data values
      * @return    float
      */
     public static function STDEV()
@@ -3076,7 +3048,6 @@ 
      *        STDEVA(value1[,value2[, ...]])
      *
      * @category Statistical Functions
-     * @param    mixed        $arg,...        Data values
      * @return    float
      */
     public static function STDEVA()
@@ -3126,7 +3097,6 @@ 
      *        STDEVP(value1[,value2[, ...]])
      *
      * @category Statistical Functions
-     * @param    mixed        $arg,...        Data values
      * @return    float
      */
     public static function STDEVP()
@@ -3171,7 +3141,6 @@ 
      *        STDEVPA(value1[,value2[, ...]])
      *
      * @category Statistical Functions
-     * @param    mixed        $arg,...        Data values
      * @return    float
      */
     public static function STDEVPA()
@@ -3403,8 +3372,6 @@ 
      *        TRIMEAN(value1[,value2[, ...]], $discard)
      *
      * @category Statistical Functions
-     * @param    mixed        $arg,...        Data values
-     * @param    float        $discard        Percentage to discard
      * @return    float
      */
     public static function TRIMMEAN()
@@ -3447,7 +3414,6 @@ 
      *        VAR(value1[,value2[, ...]])
      *
      * @category Statistical Functions
-     * @param    mixed        $arg,...        Data values
      * @return    float
      */
     public static function VARFunc()
@@ -3489,7 +3455,6 @@ 
      *        VARA(value1[,value2[, ...]])
      *
      * @category Statistical Functions
-     * @param    mixed        $arg,...        Data values
      * @return    float
      */
     public static function VARA()
@@ -3540,7 +3505,6 @@ 
      *        VARP(value1[,value2[, ...]])
      *
      * @category Statistical Functions
-     * @param    mixed        $arg,...        Data values
      * @return    float
      */
     public static function VARP()
@@ -3583,7 +3547,6 @@ 
      *        VARPA(value1[,value2[, ...]])
      *
      * @category Statistical Functions
-     * @param    mixed        $arg,...        Data values
      * @return    float
      */
     public static function VARPA()
@@ -3668,7 +3631,6 @@ 
      * @param    float        $dataSet
      * @param    float        $m0        Alpha Parameter
      * @param    float        $sigma    Beta Parameter
-     * @param    bool        $cumulative
      * @return    float
      */
     public static function ZTEST($dataSet, $m0, $sigma = null)

Spacing +2 added lines, -2 removed lines

@@ -520,8 +520,8 @@
         ];
 
         //    Define lower and upper region break-points.
-        $p_low = 0.02425;            //Use lower region approx. below this
-        $p_high = 1 - $p_low;        //Use upper region approx. above this
+        $p_low = 0.02425; //Use lower region approx. below this
+        $p_high = 1 - $p_low; //Use upper region approx. above this
 
         if (0 < $p && $p < $p_low) {
             //    Rational approximation for lower region.

src/PhpSpreadsheet/Calculation/TextData.php

Doc Comments +6 added lines, -6 removed lines

@@ -54,7 +54,7 @@ 
      * CHARACTER
      *
      * @param    string    $character    Value
-     * @return    int
+     * @return    string
      */
     public static function CHARACTER($character)
     {
@@ -183,7 +183,7 @@ 
      * This function converts a number to text using currency format, with the decimals rounded to the specified place.
      * The format used is $#,##0.00_);($#,##0.00)..
      *
-     * @param    float    $value            The value to format
+     * @param    integer    $value            The value to format
      * @param    int        $decimals        The number of digits to display to the right of the decimal point.
      *                                    If decimals is negative, number is rounded to the left of the decimal point.
      *                                    If you omit decimals, it is assumed to be 2
@@ -294,7 +294,7 @@ 
      * @param    mixed        $value    Value to check
      * @param    int        $decimals
      * @param    bool        $no_commas
-     * @return    bool
+     * @return    string
      */
     public static function FIXEDFORMAT($value, $decimals = 2, $no_commas = false)
     {
@@ -409,7 +409,7 @@ 
      * STRINGLENGTH
      *
      * @param    string    $value    Value
-     * @return    string
+     * @return    integer
      */
     public static function STRINGLENGTH($value = '')
     {
@@ -556,7 +556,7 @@ 
      * RETURNSTRING
      *
      * @param    mixed    $testValue    Value to check
-     * @return    bool
+     * @return    string|null
      */
     public static function RETURNSTRING($testValue = '')
     {
@@ -574,7 +574,7 @@ 
      *
      * @param    mixed    $value    Value to check
      * @param    string    $format    Format mask to use
-     * @return    bool
+     * @return    string
      */
     public static function TEXTFORMAT($value, $format)
     {

src/PhpSpreadsheet/Cell.php

Doc Comments +2 added lines, -2 removed lines

@@ -575,7 +575,7 @@ 
      *
      *    @param    string    $pCoordinateString
      *    @throws    Exception
-     *    @return    array    Array containing column and row (indexes 0 and 1)
+     *    @return    string[]    Array containing column and row (indexes 0 and 1)
      */
     public static function coordinateFromString($pCoordinateString = 'A1')
     {
@@ -757,7 +757,7 @@ 
      *    Calculate range boundaries
      *
      *    @param    string    $pRange        Cell range (e.g. A1:A1)
-     *    @return    array    Range coordinates array(Start Cell, End Cell)
+     *    @return    integer    Range coordinates array(Start Cell, End Cell)
      *                    where Start Cell and End Cell are arrays (Column ID, Row Number)
      */
     public static function getRangeBoundaries($pRange = 'A1:A1')

Indentation +3 added lines, -3 removed lines

@@ -845,11 +845,11 @@
                 $_indexCache[$pColumnIndex] = chr(65 + $pColumnIndex);
             } elseif ($pColumnIndex < 702) {
                 $_indexCache[$pColumnIndex] = chr(64 + ($pColumnIndex / 26)) .
-                                              chr(65 + $pColumnIndex % 26);
+                                                chr(65 + $pColumnIndex % 26);
             } else {
                 $_indexCache[$pColumnIndex] = chr(64 + (($pColumnIndex - 26) / 676)) .
-                                              chr(65 + ((($pColumnIndex - 26) % 676) / 26)) .
-                                              chr(65 + $pColumnIndex % 26);
+                                                chr(65 + ((($pColumnIndex - 26) % 676) / 26)) .
+                                                chr(65 + $pColumnIndex % 26);
             }
         }
 

src/PhpSpreadsheet/Chart/DataSeries.php

Doc Comments +3 added lines, -3 removed lines

@@ -177,7 +177,7 @@ 
     /**
      * Get Plot Grouping Type
      *
-     * @return string
+     * @return boolean
      */
     public function getPlotGrouping()
     {
@@ -200,7 +200,7 @@ 
     /**
      * Get Plot Direction
      *
-     * @return string
+     * @return boolean
      */
     public function getPlotDirection()
     {
@@ -347,7 +347,7 @@ 
     /**
      * Get Smooth Line
      *
-     * @return bool
+     * @return string
      */
     public function getSmoothLine()
     {

Spacing +2 added lines, -2 removed lines

@@ -35,14 +35,14 @@
     const TYPE_PIECHART = 'pieChart';
     const TYPE_PIECHART_3D = 'pie3DChart';
     const TYPE_DOUGHTNUTCHART = 'doughnutChart';
-    const TYPE_DONUTCHART = self::TYPE_DOUGHTNUTCHART;    //    Synonym
+    const TYPE_DONUTCHART = self::TYPE_DOUGHTNUTCHART; //    Synonym
     const TYPE_SCATTERCHART = 'scatterChart';
     const TYPE_SURFACECHART = 'surfaceChart';
     const TYPE_SURFACECHART_3D = 'surface3DChart';
     const TYPE_RADARCHART = 'radarChart';
     const TYPE_BUBBLECHART = 'bubbleChart';
     const TYPE_STOCKCHART = 'stockChart';
-    const TYPE_CANDLECHART = self::TYPE_STOCKCHART;       //    Synonym
+    const TYPE_CANDLECHART = self::TYPE_STOCKCHART; //    Synonym
 
     const GROUPING_CLUSTERED = 'clustered';
     const GROUPING_STACKED = 'stacked';

src/PhpSpreadsheet/Chart/DataSeriesValues.php

Doc Comments +3 added lines, -2 removed lines

@@ -80,6 +80,7 @@ 
 
     /**
      * Create a new DataSeriesValues object
+     * @param string $dataSource
      */
     public function __construct($dataType = self::DATASERIES_TYPE_NUMBER, $dataSource = null, $formatCode = null, $pointCount = 0, $dataValues = [], $marker = null)
     {
@@ -209,7 +210,7 @@ 
     /**
      * Identify if the Data Series is a multi-level or a simple series
      *
-     * @return    bool
+     * @return    boolean|null
      */
     public function isMultiLevelSeries()
     {
@@ -223,7 +224,7 @@ 
     /**
      * Return the level count of a multi-level Data Series
      *
-     * @return    bool
+     * @return    integer
      */
     public function multiLevelCount()
     {

src/PhpSpreadsheet/Reader/CSV.php

Doc Comments +1 added lines, -1 removed lines

@@ -387,7 +387,7 @@
     /**
      * Get Contiguous
      *
-     * @return bool
+     * @return integer
      */
     public function getContiguous()
     {

Indentation +2 added lines, -2 removed lines

@@ -254,8 +254,8 @@
         $sheet = $spreadsheet->setActiveSheetIndex($this->sheetIndex);
 
         $escapeEnclosures = ['\\' . $this->enclosure,
-                                   $this->enclosure . $this->enclosure,
-                                 ];
+                                    $this->enclosure . $this->enclosure,
+                                    ];
 
         // Set our starting row based on whether we're in contiguous mode or not
         $currentRow = 1;

Spacing +1 added lines, -1 removed lines

@@ -260,7 +260,7 @@
         // Set our starting row based on whether we're in contiguous mode or not
         $currentRow = 1;
         if ($this->contiguous) {
-            $currentRow = ($this->contiguousRow == -1) ? $sheet->getHighestRow(): $this->contiguousRow;
+            $currentRow = ($this->contiguousRow == -1) ? $sheet->getHighestRow() : $this->contiguousRow;
         }
 
         // Loop through each line of the file in turn