PHPOffice / PhpSpreadsheet

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()
     {

Indentation +1 added lines, -1 removed lines

@@ -436,7 +436,7 @@
         } // end while
     }
 
- // end constructor
+    // end constructor
 
     /**
      * Return the left singular vectors.

src/PhpSpreadsheet/Worksheet/Row.php

Doc Comments +1 added lines, -2 removed lines

@@ -43,7 +43,6 @@ 
     /**
      * Create a new row.
      *
-     * @param \PhpOffice\PhpSpreadsheet\Worksheet $parent
      * @param int $rowIndex
      */
     public function __construct(\PhpOffice\PhpSpreadsheet\Worksheet $worksheet = null, $rowIndex = 1)
@@ -87,7 +86,7 @@ 
     /**
      * Returns bound worksheet.
      *
-     * @return Worksheet
+     * @return 
      */
     public function getWorksheet()
     {

src/PhpSpreadsheet/Writer/Xls/Workbook.php

Doc Comments +3 added lines, -3 removed lines

@@ -240,8 +240,8 @@ 
      *
      * @param \PhpOffice\PhpSpreadsheet\Style
      * @param bool Is it a style XF?
-     * @param mixed $style
-     * @param mixed $isStyleXf
+     * @param \PhpOffice\PhpSpreadsheet\Style $style
+     * @param boolean $isStyleXf
      *
      * @return int Index to XF record
      */
@@ -796,7 +796,7 @@ 
      *
      * @param string $name The name in UTF-8
      * @param string $formulaData The binary formula data
-     * @param string $sheetIndex 1-based sheet index the defined name applies to. 0 = global
+     * @param integer $sheetIndex 1-based sheet index the defined name applies to. 0 = global
      * @param bool $isBuiltIn Built-in name?
      *
      * @return string Complete binary record data

src/PhpSpreadsheet/Calculation/Engineering.php

Doc Comments +5 added lines, -5 removed lines

@@ -1853,7 +1853,7 @@ 
      *
      * @param string $complexNumber the complex number for which you want the real coefficient
      *
-     * @return float
+     * @return string
      */
     public static function IMREAL($complexNumber)
     {
@@ -2291,7 +2291,7 @@ 
      * Excel Function:
      *        IMSUM(complexNumber[,complexNumber[,...]])
      *
-     * @param string $complexNumbers Series of complex numbers to add
+     * @param string[] $complexNumbers Series of complex numbers to add
      *
      * @return string
      */
@@ -2331,7 +2331,7 @@ 
      * Excel Function:
      *        IMPRODUCT(complexNumber[,complexNumber[,...]])
      *
-     * @param string $complexNumbers Series of complex numbers to multiply
+     * @param string[] $complexNumbers Series of complex numbers to multiply
      *
      * @return string
      */
@@ -2375,7 +2375,7 @@ 
      *        DELTA(a[,b])
      *
      * @param float $a the first number
-     * @param float $b The second number. If omitted, b is assumed to be zero.
+     * @param integer $b The second number. If omitted, b is assumed to be zero.
      *
      * @return int
      */
@@ -2398,7 +2398,7 @@ 
      * functions you calculate the count of values that exceed a threshold.
      *
      * @param float $number the value to test against step
-     * @param float $step The threshold value.
+     * @param integer $step The threshold value.
      *                                    If you omit a value for step, GESTEP uses zero.
      *
      * @return int

src/PhpSpreadsheet/Calculation/MathTrig.php

Doc Comments +11 added lines, -11 removed lines

@@ -52,6 +52,10 @@ 
         return [(int) $value];
     }
 
+    /**
+     * @param integer $num
+     * @param integer $n
+     */
     private static function romanCut($num, $n)
     {
         return ($num - ($num % $n)) / $n;
@@ -504,7 +508,7 @@ 
      * @category Mathematical and Trigonometric Functions
      *
      * @param float $number The positive real number for which you want the logarithm
-     * @param float $base The base of the logarithm. If base is omitted, it is assumed to be 10.
+     * @param integer $base The base of the logarithm. If base is omitted, it is assumed to be 10.
      *
      * @return float
      */
@@ -822,8 +826,8 @@ 
      *
      * Computes x raised to the power y.
      *
-     * @param float $x
-     * @param float $y
+     * @param integer $x
+     * @param integer $y
      *
      * @return float
      */
@@ -897,7 +901,7 @@ 
      *
      * @param mixed $args Data values
      *
-     * @return float
+     * @return integer
      */
     public static function QUOTIENT(...$args)
     {
@@ -1035,9 +1039,6 @@ 
      *
      * Returns the sum of a power series
      *
-     * @param float $x Input value to the power series
-     * @param float $n Initial power to which you want to raise $x
-     * @param float $m Step by which to increase $n for each term in the series
      * @param array of mixed Data Series
      *
      * @return float
@@ -1215,7 +1216,7 @@ 
      * @param mixed $aArgs
      * @param mixed $sumArgs
      *
-     * @return float
+     * @return integer
      */
     public static function SUMIF($aArgs, $condition, $sumArgs = [])
     {
@@ -1255,9 +1256,8 @@ 
      *    @category Mathematical and Trigonometric Functions
      *
      * @param mixed $args Data values
-     * @param string $condition the criteria that defines which cells will be summed
      *
-     * @return float
+     * @return integer
      */
     public static function SUMIFS(...$args)
     {
@@ -1446,7 +1446,7 @@ 
      *
      * Truncates value to the number of fractional digits by number_digits.
      *
-     * @param float $value
+     * @param integer $value
      * @param int $digits
      *
      * @return float Truncated value

src/PhpSpreadsheet/Calculation/Statistical.php

Doc Comments +9 added lines, -14 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)
     {
@@ -909,8 +909,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
      */
@@ -948,8 +948,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
      */
@@ -2015,7 +2015,6 @@ 
      * @category Statistical Functions
      *
      * @param mixed $args Data values
-     * @param int $entry Position (ordered from the largest) in the array or range of data to return
      *
      * @return float
      */
@@ -2745,7 +2744,6 @@ 
      * @category Statistical Functions
      *
      * @param mixed $args Data values
-     * @param float $entry Percentile value in the range 0..1, inclusive.
      *
      * @return float
      */
@@ -2796,7 +2794,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
      */
@@ -2917,7 +2915,6 @@ 
      * @category Statistical Functions
      *
      * @param mixed $args Data values
-     * @param int $entry Quartile value in the range 1..3, inclusive.
      *
      * @return float
      */
@@ -2950,7 +2947,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
      */
@@ -3092,7 +3089,6 @@ 
      * @category Statistical Functions
      *
      * @param mixed $args Data values
-     * @param int $entry Position (ordered from the smallest) in the array or range of data to return
      *
      * @return float
      */
@@ -3556,7 +3552,6 @@ 
      * @category Statistical Functions
      *
      * @param mixed $args Data values
-     * @param float $discard Percentage to discard
      *
      * @return float
      */

src/PhpSpreadsheet/Calculation/LookupRef.php

Doc Comments +11 added lines, -11 removed lines

@@ -36,7 +36,7 @@ 
      *
      * @param row Row number to use in the cell reference
      * @param column Column number to use in the cell reference
-     * @param relativity Flag indicating the type of reference to return
+     * @param relativity integer indicating the type of reference to return
      *                                1 or omitted    Absolute
      *                                2                Absolute row; relative column
      *                                3                Relative row; absolute column
@@ -47,7 +47,7 @@ 
      * @param sheetText Optional Name of worksheet to use
      * @param mixed $row
      * @param mixed $column
-     * @param mixed $relativity
+     * @param integer $relativity
      * @param mixed $referenceStyle
      * @param mixed $sheetText
      *
@@ -358,7 +358,7 @@ 
      *
      * @param cellAddress The reference from which you want to base the offset. Reference must refer to a cell or
      *                                range of adjacent cells; otherwise, OFFSET returns the #VALUE! error value.
-     * @param rows The number of rows, up or down, that you want the upper-left cell to refer to.
+     * @param rows integer number of rows, up or down, that you want the upper-left cell to refer to.
      *                                Using 5 as the rows argument specifies that the upper-left cell in the reference is
      *                                five rows below reference. Rows can be positive (which means below the starting reference)
      *                                or negative (which means above the starting reference).
@@ -370,8 +370,8 @@ 
      * @param height The height, in number of rows, that you want the returned reference to be. Height must be a positive number.
      * @param width The width, in number of columns, that you want the returned reference to be. Width must be a positive number.
      * @param null|mixed $cellAddress
-     * @param mixed $rows
-     * @param mixed $columns
+     * @param integer $rows
+     * @param integer $columns
      * @param null|mixed $height
      * @param null|mixed $width
      * @param \PhpOffice\PhpSpreadsheet\Cell $pCell
@@ -499,10 +499,10 @@ 
      *
      * @param lookup_value The value that you want to match in lookup_array
      * @param lookup_array The range of cells being searched
-     * @param match_type The number -1, 0, or 1. -1 means above, 0 means exact match, 1 means below. If match_type is 1 or -1, the list has to be ordered.
+     * @param match_type integer number -1, 0, or 1. -1 means above, 0 means exact match, 1 means below. If match_type is 1 or -1, the list has to be ordered.
      * @param mixed $lookup_value
      * @param mixed $lookup_array
-     * @param mixed $match_type
+     * @param integer $match_type
      *
      * @return int The relative position of the found item
      */
@@ -599,8 +599,8 @@ 
      * @param row_num The row in array from which to return a value. If row_num is omitted, column_num is required.
      * @param column_num The column in array from which to return a value. If column_num is omitted, row_num is required.
      * @param mixed $arrayValues
-     * @param mixed $rowNum
-     * @param mixed $columnNum
+     * @param integer $rowNum
+     * @param integer $columnNum
      *
      * @return mixed the value of a specified cell or array of cells
      */
@@ -696,11 +696,11 @@ 
      *
      * @param lookup_value The value that you want to match in lookup_array
      * @param lookup_array The range of cells being searched
-     * @param index_number The column number in table_array from which the matching value must be returned. The first column is 1.
+     * @param index_number integer column number in table_array from which the matching value must be returned. The first column is 1.
      * @param not_exact_match determines if you are looking for an exact match based on lookup_value
      * @param mixed $lookup_value
      * @param mixed $lookup_array
-     * @param mixed $index_number
+     * @param integer $index_number
      * @param mixed $not_exact_match
      *
      * @return mixed The value of the found cell

src/PhpSpreadsheet/Reader/Slk.php

Doc Comments +1 added lines, -1 removed lines

@@ -472,7 +472,7 @@
      *
      * @param int $pValue Sheet index
      *
-     * @return SYLK
+     * @return Slk
      */
     public function setSheetIndex($pValue = 0)
     {