PHPOffice / PhpSpreadsheet

src/PhpSpreadsheet/Calculation/LookupRef.php

Doc Comments +10 added lines, -10 removed lines

@@ -38,7 +38,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
@@ -49,7 +49,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
      *
@@ -360,7 +360,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).
@@ -372,8 +372,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 Cell $pCell
@@ -501,7 +501,7 @@ 
      *
      * @param mixed $lookupValue The value that you want to match in lookup_array
      * @param mixed $lookupArray The range of cells being searched
-     * @param mixed $matchType 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 integer $matchType 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.
      *
      * @return int The relative position of the found item
      */
@@ -615,8 +615,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
      */
@@ -712,11 +712,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/Writer/Xls/Xf.php

Doc Comments +1 added lines, -1 removed lines

@@ -140,7 +140,7 @@
     /**
      * Constructor.
      *
-     * @param Style The XF format
+     * @param Style Style XF format
      */
     public function __construct(Style $style)
     {

src/PhpSpreadsheet/Worksheet/Row.php

Doc Comments -1 removed lines

@@ -45,7 +45,6 @@
     /**
      * Create a new row.
      *
-     * @param Worksheet $parent
      * @param int $rowIndex
      */
     public function __construct(Worksheet $worksheet = null, $rowIndex = 1)

src/PhpSpreadsheet/Shared/JAMA/LUDecomposition.php

Doc Comments +1 added lines, -1 removed lines

@@ -243,7 +243,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 CalculationException illegalArgumentException Matrix row dimensions must agree
      * @throws CalculationException runtimeException  Matrix is singular

src/PhpSpreadsheet/Shared/OLERead.php

Doc Comments +1 added lines, -1 removed lines

@@ -71,7 +71,7 @@
     /**
      * Read the file.
      *
-     * @param $pFilename string Filename
+     * @param string $pFilename string Filename
      *
      * @throws ReaderException
      */

src/PhpSpreadsheet/Chart/Layout.php

Doc Comments +4 added lines, -4 removed lines

@@ -236,7 +236,7 @@ 
     /**
      * Get X-Position.
      *
-     * @return number
+     * @return string
      */
     public function getXPosition()
     {
@@ -260,7 +260,7 @@ 
     /**
      * Get Y-Position.
      *
-     * @return number
+     * @return string
      */
     public function getYPosition()
     {
@@ -284,7 +284,7 @@ 
     /**
      * Get Width.
      *
-     * @return number
+     * @return string
      */
     public function getWidth()
     {
@@ -308,7 +308,7 @@ 
     /**
      * Get Height.
      *
-     * @return number
+     * @return string
      */
     public function getHeight()
     {

src/PhpSpreadsheet/Calculation/Engineering.php

Doc Comments +5 added lines, -3 removed lines

@@ -1855,7 +1855,7 @@ 
      *
      * @param string $complexNumber the complex number for which you want the real coefficient
      *
-     * @return float
+     * @return string
      */
     public static function IMREAL($complexNumber)
     {
@@ -2294,6 +2294,7 @@ 
      *        IMSUM(complexNumber[,complexNumber[,...]])
      *
      * @param string ...$complexNumbers Series of complex numbers to add
+     * @param string[] $complexNumbers
      *
      * @return string
      */
@@ -2334,6 +2335,7 @@ 
      *        IMPRODUCT(complexNumber[,complexNumber[,...]])
      *
      * @param string ...$complexNumbers Series of complex numbers to multiply
+     * @param string[] $complexNumbers
      *
      * @return string
      */
@@ -2377,7 +2379,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
      */
@@ -2400,7 +2402,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

@@ -56,6 +56,10 @@ 
         return [(int) $value];
     }
 
+    /**
+     * @param integer $num
+     * @param integer $n
+     */
     private static function romanCut($num, $n)
     {
         return ($num - ($num % $n)) / $n;
@@ -508,7 +512,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
      */
@@ -826,8 +830,8 @@ 
      *
      * Computes x raised to the power y.
      *
-     * @param float $x
-     * @param float $y
+     * @param integer $x
+     * @param integer $y
      *
      * @return float
      */
@@ -901,7 +905,7 @@ 
      *
      * @param mixed ...$args Data values
      *
-     * @return float
+     * @return integer
      */
     public static function QUOTIENT(...$args)
     {
@@ -1039,9 +1043,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
@@ -1219,7 +1220,7 @@ 
      * @param mixed $aArgs
      * @param mixed $sumArgs
      *
-     * @return float
+     * @return integer
      */
     public static function SUMIF($aArgs, $condition, $sumArgs = [])
     {
@@ -1259,9 +1260,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)
     {
@@ -1450,7 +1450,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/NamedRange.php

Doc Comments +1 added lines, -1 removed lines

@@ -212,7 +212,7 @@
      * Resolve a named range to a regular cell range.
      *
      * @param string $pNamedRange Named range
-     * @param null|Worksheet $pSheet Scope. Use null for global scope
+     * @param Worksheet $pSheet Scope. Use null for global scope
      *
      * @return NamedRange
      */