PHPOffice / PhpSpreadsheet

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

Indentation +1 added lines, -1 removed lines

@@ -778,7 +778,7 @@
         }
     }
 
- // end hqr2
+    // end hqr2
 
     /**
      * Constructor: Check for symmetry, then construct the eigenvalue decomposition.

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

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.php

Doc Comments +10 added lines, -10 removed lines

@@ -590,7 +590,7 @@ 
      *
      * @throws Exception
      *
-     * @return false|Chart
+     * @return null|Chart
      */
     public function getChartByIndex($index = null)
     {
@@ -1120,7 +1120,7 @@ 
      * Set a cell value.
      *
      * @param string $pCoordinate Coordinate of the cell
-     * @param mixed $pValue Value of the cell
+     * @param integer $pValue Value of the cell
      * @param bool $returnCell Return the worksheet (false, default) or the cell (true)
      *
      * @return Worksheet|Cell Depending on the last parameter being specified
@@ -1237,8 +1237,8 @@ 
     /**
      * Get cell at a specific coordinate by using numeric cell coordinates.
      *
-     * @param string $pColumn Numeric column coordinate of the cell
-     * @param string $pRow Numeric row coordinate of the cell
+     * @param integer $pColumn Numeric column coordinate of the cell
+     * @param integer $pRow Numeric row coordinate of the cell
      * @param bool $createIfNotExists Flag indicating whether a new cell should be created if it doesn't
      *                                       already exist, or a null should be returned instead
      *
@@ -1348,8 +1348,8 @@ 
     /**
      * Cell at a specific coordinate by using numeric cell coordinates exists?
      *
-     * @param string $pColumn Numeric column coordinate of the cell
-     * @param string $pRow Numeric row coordinate of the cell
+     * @param integer $pColumn Numeric column coordinate of the cell
+     * @param integer $pRow Numeric row coordinate of the cell
      *
      * @return bool
      */
@@ -1362,7 +1362,7 @@ 
      * Get row dimension at a specific row.
      *
      * @param int $pRow Numeric index of the row
-     * @param mixed $create
+     * @param boolean $create
      *
      * @return Worksheet\RowDimension
      */
@@ -1388,7 +1388,7 @@ 
      * Get column dimension at a specific column.
      *
      * @param string $pColumn String index of the column
-     * @param mixed $create
+     * @param boolean $create
      *
      * @return Worksheet\ColumnDimension
      */
@@ -1934,7 +1934,7 @@ 
     /**
      * Set AutoFilter.
      *
-     * @param Worksheet\AutoFilter|string $pValue
+     * @param string $pValue
      *            A simple string containing a Cell range like 'A1:E10' is permitted for backward compatibility
      *
      * @throws Exception
@@ -2996,7 +2996,7 @@ 
      *
      * @throws Exception
      *
-     * @return objWorksheet
+     * @return Worksheet
      */
     public function setCodeName($pValue = null)
     {

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