PHPOffice / PhpSpreadsheet

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

Spacing +1 added lines, -1 removed lines

@@ -3849,7 +3849,7 @@
      *
      * @return bool
      */
-    private function executeBinaryComparisonOperation($cellID, $operand1, $operand2, $operation, Stack &$stack, $recursingArrays = false)
+    private function executeBinaryComparisonOperation($cellID, $operand1, $operand2, $operation, Stack & $stack, $recursingArrays = false)
     {
         //    If we're dealing with matrix operations, we want a matrix result
         if ((is_array($operand1)) || (is_array($operand2))) {

Doc Comments +5 added lines, -2 removed lines

@@ -2672,7 +2672,7 @@ 
 
     /**
      * @param string $cellReference
-     * @param mixed $cellValue
+     * @param boolean $cellValue
      */
     public function saveValueToCache($cellReference, $cellValue)
     {
@@ -2797,7 +2797,7 @@ 
      *
      * @param mixed &$matrix matrix operand
      *
-     * @return int[] An array comprising the number of rows, and number of columns
+     * @return integer[] An array comprising the number of rows, and number of columns
      */
     private static function getMatrixDimensions(&$matrix)
     {
@@ -3800,6 +3800,9 @@ 
         return $output;
     }
 
+    /**
+     * @param null|string $cellID
+     */
     private function validateBinaryOperand($cellID, &$operand, &$stack)
     {
         if (is_array($operand)) {

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
      */

src/PhpSpreadsheet/Shared/Font.php

Doc Comments +1 added lines, -1 removed lines

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

src/PhpSpreadsheet/Shared/OLE/PPS/Root.php

Doc Comments +2 added lines, -2 removed lines

@@ -59,7 +59,7 @@ 
      * If a resource pointer to a stream created by fopen() is passed
      * it will be used, but you have to close such stream by yourself.
      *
-     * @param resource|string $filename the name of the file or stream where to save the OLE container
+     * @param string $filename the name of the file or stream where to save the OLE container
      *
      * @throws WriterException
      *
@@ -124,7 +124,7 @@ 
      *
      * @param array $raList Reference to an array of PPS's
      *
-     * @return float[] The array of numbers
+     * @return double[] The array of numbers
      */
     public function _calcSize(&$raList)
     {

src/PhpSpreadsheet/Worksheet.php

Doc Comments +7 added lines, -7 removed lines

@@ -558,7 +558,7 @@ 
      *
      * @throws Exception
      *
-     * @return Chart|false
+     * @return Chart
      */
     public function getChartByIndex($index)
     {
@@ -1069,7 +1069,7 @@ 
      * @param string $column Return the highest data row for the specified column,
      *                                     or the highest data row of any column if no column letter is passed
      *
-     * @return string Highest row number that contains data
+     * @return integer Highest row number that contains data
      */
     public function getHighestDataRow($column = null)
     {
@@ -1121,7 +1121,7 @@ 
      * Set a cell value.
      *
      * @param string $pCoordinate Coordinate of the cell, eg: 'A1'
-     * @param mixed $pValue Value of the cell
+     * @param string $pValue Value of the cell
      * @param string $pDataType Explicit data type, see Cell\DataType::TYPE_*
      *
      * @return Worksheet
@@ -1327,7 +1327,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
      */
@@ -1353,7 +1353,7 @@ 
      * Get column dimension at a specific column.
      *
      * @param string $pColumn String index of the column eg: 'A'
-     * @param mixed $create
+     * @param boolean $create
      *
      * @return Worksheet\ColumnDimension
      */
@@ -1899,7 +1899,7 @@ 
     /**
      * Set AutoFilter.
      *
-     * @param string|Worksheet\AutoFilter $pValue
+     * @param string $pValue
      *            A simple string containing a Cell range like 'A1:E10' is permitted for backward compatibility
      *
      * @throws Exception
@@ -2965,7 +2965,7 @@ 
      *
      * @throws Exception
      *
-     * @return objWorksheet
+     * @return Worksheet
      */
     public function setCodeName($pValue, $validate = true)
     {