PHPOffice / PhpSpreadsheet

src/PhpSpreadsheet/Calculation/Statistical.php

Doc Comments +9 added lines, -46 removed lines

@@ -133,7 +133,7 @@ 
      * @param mixed $p
      * @param mixed $q
      *
-     * @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
      */
@@ -159,8 +159,8 @@ 
      * @author Jaco van Kooten
      *
      * @param mixed $x
-     * @param mixed $p
-     * @param mixed $q
+     * @param double $p
+     * @param double $q
      */
     private static function betaFraction($x, $p, $q)
     {
@@ -722,7 +722,6 @@ 
      *
      * @category Statistical Functions
      *
-     * @param mixed $arg,... Data values
      *
      * @return float
      */
@@ -773,7 +772,6 @@ 
      *
      * @category Statistical Functions
      *
-     * @param mixed $arg,... Data values
      *
      * @return float
      */
@@ -816,7 +814,6 @@ 
      *
      * @category Statistical Functions
      *
-     * @param mixed $arg,... Data values
      *
      * @return float
      */
@@ -863,7 +860,6 @@ 
      *
      * @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
      * @param mixed $aArgs
@@ -910,8 +906,8 @@ 
      * @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 mixed $rMin
-     * @param mixed $rMax
+     * @param integer $rMin
+     * @param integer $rMax
      *
      * @return float
      */
@@ -949,8 +945,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 integer $rMin Minimum value
+     * @param integer $rMax Maximum value
      *
      * @return float
      */
@@ -1210,7 +1206,6 @@ 
      *
      * @category Statistical Functions
      *
-     * @param mixed $arg,... Data values
      *
      * @return int
      */
@@ -1244,7 +1239,6 @@ 
      *
      * @category Statistical Functions
      *
-     * @param mixed $arg,... Data values
      *
      * @return int
      */
@@ -1274,7 +1268,6 @@ 
      *
      * @category Statistical Functions
      *
-     * @param mixed $arg,... Data values
      *
      * @return int
      */
@@ -1304,7 +1297,6 @@ 
      *
      * @category Statistical Functions
      *
-     * @param mixed $arg,... Data values
      * @param string $condition the criteria that defines which cells will be counted
      * @param mixed $aArgs
      *
@@ -1495,7 +1487,6 @@ 
      *
      * @category Statistical Functions
      *
-     * @param mixed $arg,... Data values
      *
      * @return float
      */
@@ -1789,7 +1780,6 @@ 
      *
      * @category Statistical Functions
      *
-     * @param mixed $arg,... Data values
      *
      * @return float
      */
@@ -1855,7 +1845,6 @@ 
      *
      * @category Statistical Functions
      *
-     * @param mixed $arg,... Data values
      *
      * @return float
      */
@@ -2016,8 +2005,6 @@ 
      *
      * @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
      */
@@ -2253,7 +2240,6 @@ 
      *
      * @category Statistical Functions
      *
-     * @param mixed $arg,... Data values
      *
      * @return float
      */
@@ -2289,7 +2275,6 @@ 
      *
      * @category Statistical Functions
      *
-     * @param mixed $arg,... Data values
      *
      * @return float
      */
@@ -2330,7 +2315,6 @@ 
      *
      * @category Mathematical and Trigonometric Functions
      *
-     * @param mixed $arg,... Data values
      * @param string $condition the criteria that defines which cells will be checked
      * @param mixed $aArgs
      * @param mixed $sumArgs
@@ -2373,7 +2357,6 @@ 
      *
      * @category Statistical Functions
      *
-     * @param mixed $arg,... Data values
      *
      * @return float
      */
@@ -2417,7 +2400,6 @@ 
      *
      * @category Statistical Functions
      *
-     * @param mixed $arg,... Data values
      *
      * @return float
      */
@@ -2453,7 +2435,6 @@ 
      *
      * @category Statistical Functions
      *
-     * @param mixed $arg,... Data values
      *
      * @return float
      */
@@ -2494,7 +2475,6 @@ 
      *
      * @category Mathematical and Trigonometric Functions
      *
-     * @param mixed $arg,... Data values
      * @param string $condition the criteria that defines which cells will be checked
      * @param mixed $aArgs
      * @param mixed $sumArgs
@@ -2574,7 +2554,6 @@ 
      *
      * @category Statistical Functions
      *
-     * @param mixed $arg,... Data values
      *
      * @return float
      */
@@ -2748,8 +2727,6 @@ 
      *
      * @category Statistical Functions
      *
-     * @param mixed $arg,... Data values
-     * @param float $entry Percentile value in the range 0..1, inclusive.
      *
      * @return float
      */
@@ -2800,7 +2777,7 @@ 
      * @param number the number of significant digits for the returned percentage value
      * @param mixed $valueSet
      * @param mixed $value
-     * @param mixed $significance
+     * @param integer $significance
      *
      * @return float
      */
@@ -2920,8 +2897,6 @@ 
      *
      * @category Statistical Functions
      *
-     * @param mixed $arg,... Data values
-     * @param int $entry Quartile value in the range 1..3, inclusive.
      *
      * @return float
      */
@@ -2954,7 +2929,7 @@ 
      * @param mixed Order to sort the values in the value set
      * @param mixed $value
      * @param mixed $valueSet
-     * @param mixed $order
+     * @param integer $order
      *
      * @return float
      */
@@ -3095,8 +3070,6 @@ 
      *
      * @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
      */
@@ -3167,7 +3140,6 @@ 
      *
      * @category Statistical Functions
      *
-     * @param mixed $arg,... Data values
      *
      * @return float
      */
@@ -3216,7 +3188,6 @@ 
      *
      * @category Statistical Functions
      *
-     * @param mixed $arg,... Data values
      *
      * @return float
      */
@@ -3268,7 +3239,6 @@ 
      *
      * @category Statistical Functions
      *
-     * @param mixed $arg,... Data values
      *
      * @return float
      */
@@ -3315,7 +3285,6 @@ 
      *
      * @category Statistical Functions
      *
-     * @param mixed $arg,... Data values
      *
      * @return float
      */
@@ -3559,8 +3528,6 @@ 
      *
      * @category Statistical Functions
      *
-     * @param mixed $arg,... Data values
-     * @param float $discard Percentage to discard
      *
      * @return float
      */
@@ -3605,7 +3572,6 @@ 
      *
      * @category Statistical Functions
      *
-     * @param mixed $arg,... Data values
      *
      * @return float
      */
@@ -3649,7 +3615,6 @@ 
      *
      * @category Statistical Functions
      *
-     * @param mixed $arg,... Data values
      *
      * @return float
      */
@@ -3702,7 +3667,6 @@ 
      *
      * @category Statistical Functions
      *
-     * @param mixed $arg,... Data values
      *
      * @return float
      */
@@ -3747,7 +3711,6 @@ 
      *
      * @category Statistical Functions
      *
-     * @param mixed $arg,... Data values
      *
      * @return float
      */

src/PhpSpreadsheet/Calculation/TextData.php

Doc Comments +1 added lines, -1 removed lines

@@ -169,7 +169,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

src/PhpSpreadsheet/Cell.php

Doc Comments +1 added lines, -1 removed lines

@@ -781,7 +781,7 @@
      *
      * @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')

src/PhpSpreadsheet/Shared/Date.php

Doc Comments +4 added lines, -4 removed lines

@@ -167,7 +167,7 @@ 
     /**
      * Convert a MS serialized datetime value from Excel to a PHP Date/Time object.
      *
-     * @param int|float $excelTimestamp MS Excel serialized date/time value
+     * @param integer $excelTimestamp MS Excel serialized date/time value
      * @param \DateTimeZone|string|null $timeZone The timezone to assume for the Excel timestamp,
      *                                                                        if you don't want to treat it as a UTC value
      *                                                                    Use the default (UST) unless you absolutely need a conversion
@@ -208,7 +208,7 @@ 
     /**
      * Convert a MS serialized datetime value from Excel to a unix timestamp.
      *
-     * @param int|float $excelTimestamp MS Excel serialized date/time value
+     * @param integer $excelTimestamp MS Excel serialized date/time value
      * @param \DateTimeZone|string|null $timeZone The timezone to assume for the Excel timestamp,
      *                                                                        if you don't want to treat it as a UTC value
      *                                                                    Use the default (UST) unless you absolutely need a conversion
@@ -226,7 +226,7 @@ 
     /**
      * Convert a date from PHP to an MS Excel serialized date/time value.
      *
-     * @param mixed $dateValue Unix Timestamp or PHP DateTime object or a string
+     * @param integer $dateValue Unix Timestamp or PHP DateTime object or a string
      *
      * @return float|bool Excel date/time value
      *                                  or boolean FALSE on failure
@@ -266,7 +266,7 @@ 
     /**
      * Convert a Unix timestamp to an MS Excel serialized date/time value.
      *
-     * @param \DateTimeInterface $dateValue Unix Timestamp
+     * @param integer $dateValue Unix Timestamp
      *
      * @return float MS Excel serialized date/time value
      */

src/PhpSpreadsheet/Shared/Font.php

Doc Comments +1 added lines, -1 removed lines

@@ -236,7 +236,7 @@
      * Calculate an (approximate) OpenXML column width, based on font size and text contained.
      *
      * @param \PhpOffice\PhpSpreadsheet\Style\Font $font Font object
-     * @param \PhpOffice\PhpSpreadsheet\RichText|string $cellText Text to calculate width
+     * @param string $cellText Text to calculate width
      * @param int $rotation Rotation angle
      * @param \PhpOffice\PhpSpreadsheet\Style\Font|null $defaultFont Font object
      *

src/PhpSpreadsheet/Shared/JAMA/EigenvalueDecomposition.php

Doc Comments +2 added lines, -2 removed lines

@@ -819,7 +819,7 @@ 
     /**
      * Return the eigenvector matrix.
      *
-     * @return V
+     * @return Matrix
      */
     public function getV()
     {
@@ -849,7 +849,7 @@ 
     /**
      * Return the block diagonal eigenvalue matrix.
      *
-     * @return D
+     * @return Matrix
      */
     public function getD()
     {

src/PhpSpreadsheet/Shared/JAMA/LUDecomposition.php

Doc Comments +1 added lines, -1 removed lines

@@ -241,7 +241,7 @@
     /**
      * Solve A*X = B.
      *
-     * @param $B a Matrix with as many rows as A and any number of columns
+     * @param Matrix $B a Matrix with as many rows as A and any number of columns
      *
      * @throws \PhpOffice\PhpSpreadsheet\Calculation\Exception illegalArgumentException Matrix row dimensions must agree
      * @throws \PhpOffice\PhpSpreadsheet\Calculation\Exception runtimeException  Matrix is singular

src/PhpSpreadsheet/Shared/JAMA/Matrix.php

Doc Comments +2 added lines, -19 removed lines

@@ -149,10 +149,6 @@ 
      *
      *    Get a submatrix
      *
-     * @param int $i0 Initial row index
-     * @param int $iF Final row index
-     * @param int $j0 Initial column index
-     * @param int $jF Final column index
      *
      * @return Matrix Submatrix
      */
@@ -345,7 +341,7 @@ 
      *
      * @param int $m Row dimension
      * @param int $n Column dimension
-     * @param mixed $c Diagonal value
+     * @param integer $c Diagonal value
      *
      * @return Matrix Diagonal matrix
      */
@@ -429,7 +425,7 @@ 
      *
      *    Sum of diagonal elements
      *
-     * @return float Sum of diagonal elements
+     * @return integer Sum of diagonal elements
      */
     public function trace()
     {
@@ -458,7 +454,6 @@ 
      *
      *    A + B
      *
-     * @param mixed $B Matrix/Array
      *
      * @return Matrix Sum
      */
@@ -500,7 +495,6 @@ 
      *
      *    A = A + B
      *
-     * @param mixed $B Matrix/Array
      *
      * @return Matrix Sum
      */
@@ -556,7 +550,6 @@ 
      *
      *    A - B
      *
-     * @param mixed $B Matrix/Array
      *
      * @return Matrix Sum
      */
@@ -598,7 +591,6 @@ 
      *
      *    A = A - B
      *
-     * @param mixed $B Matrix/Array
      *
      * @return Matrix Sum
      */
@@ -655,7 +647,6 @@ 
      *    Element-by-element multiplication
      *    Cij = Aij * Bij
      *
-     * @param mixed $B Matrix/Array
      *
      * @return Matrix Matrix Cij
      */
@@ -698,7 +689,6 @@ 
      *    Element-by-element multiplication
      *    Aij = Aij * Bij
      *
-     * @param mixed $B Matrix/Array
      *
      * @return Matrix Matrix Aij
      */
@@ -755,7 +745,6 @@ 
      *    Element-by-element right division
      *    A / B
      *
-     * @param Matrix $B Matrix B
      *
      * @return Matrix Division result
      */
@@ -817,7 +806,6 @@ 
      *    Element-by-element right division
      *    Aij = Aij / Bij
      *
-     * @param mixed $B Matrix/Array
      *
      * @return Matrix Matrix Aij
      */
@@ -860,7 +848,6 @@ 
      *    Element-by-element Left division
      *    A / B
      *
-     * @param Matrix $B Matrix B
      *
      * @return Matrix Division result
      */
@@ -903,7 +890,6 @@ 
      *    Element-by-element Left division
      *    Aij = Aij / Bij
      *
-     * @param mixed $B Matrix/Array
      *
      * @return Matrix Matrix Aij
      */
@@ -945,7 +931,6 @@ 
      *
      *    Matrix multiplication
      *
-     * @param mixed $n Matrix/Array/Scalar
      *
      * @return Matrix Product
      */
@@ -1038,7 +1023,6 @@ 
      *
      *    A = A ^ B
      *
-     * @param mixed $B Matrix/Array
      *
      * @return Matrix Sum
      */
@@ -1094,7 +1078,6 @@ 
      *
      *    A = A & B
      *
-     * @param mixed $B Matrix/Array
      *
      * @return Matrix Sum
      */

src/PhpSpreadsheet/Shared/JAMA/SingularValueDecomposition.php

Doc Comments +3 added lines, -3 removed lines

@@ -441,7 +441,7 @@ 
     /**
      * Return the left singular vectors.
      *
-     * @return U
+     * @return Matrix
      */
     public function getU()
     {
@@ -451,7 +451,7 @@ 
     /**
      * Return the right singular vectors.
      *
-     * @return V
+     * @return Matrix
      */
     public function getV()
     {
@@ -471,7 +471,7 @@ 
     /**
      * Return the diagonal matrix of singular values.
      *
-     * @return S
+     * @return Matrix
      */
     public function getS()
     {