PHPOffice / PhpSpreadsheet

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/Writer/Xls/Worksheet.php

Doc Comments +9 added lines, -7 removed lines

@@ -223,10 +223,12 @@ 
      * @param int &$str_unique Total number of unique strings
      * @param array &$str_table String Table
      * @param array &$colors Colour Table
-     * @param mixed $parser The formula parser created for the Workbook
+     * @param Parser $parser The formula parser created for the Workbook
      * @param bool $preCalculateFormulas Flag indicating whether formulas should be calculated or just written
      * @param string $phpSheet The worksheet to write
      * @param \PhpOffice\PhpSpreadsheet\Worksheet $phpSheet
+     * @param integer $str_total
+     * @param integer $str_unique
      */
     public function __construct(&$str_total, &$str_unique, &$str_table, &$colors, $parser, $preCalculateFormulas, $phpSheet)
     {
@@ -624,7 +626,7 @@ 
      * @param int $row Zero indexed row
      * @param int $col Zero indexed column
      * @param float $num The number to write
-     * @param mixed $xfIndex The optional XF format
+     * @param integer $xfIndex The optional XF format
      *
      * @return int
      */
@@ -733,7 +735,7 @@ 
      * @param int $row Zero indexed row
      * @param int $col Zero indexed column
      * @param string $str The string to write
-     * @param mixed $xfIndex The XF format index for the cell
+     * @param integer $xfIndex The XF format index for the cell
      *
      * @return int
      */
@@ -800,7 +802,7 @@ 
      *
      * @param int $row Zero indexed row
      * @param int $col Zero indexed column
-     * @param mixed $xfIndex The XF format index
+     * @param integer $xfIndex The XF format index
      */
     public function writeBlank($row, $col, $xfIndex)
     {
@@ -847,7 +849,7 @@ 
      * @param int $row Zero indexed row
      * @param int $col Zero indexed column
      * @param string $formula The formula text string
-     * @param mixed $xfIndex The XF format index
+     * @param integer $xfIndex The XF format index
      * @param mixed $calculatedValue Calculated value
      *
      * @return int
@@ -2327,8 +2329,8 @@ 
      * @param mixed $bitmap The bitmap filename or GD-image resource
      * @param int $x the horizontal position (offset) of the image inside the cell
      * @param int $y the vertical position (offset) of the image inside the cell
-     * @param float $scale_x The horizontal scale
-     * @param float $scale_y The vertical scale
+     * @param integer $scale_x The horizontal scale
+     * @param integer $scale_y The vertical scale
      */
     public function insertBitmap($row, $col, $bitmap, $x = 0, $y = 0, $scale_x = 1, $scale_y = 1)
     {

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/Reader/Csv.php

Doc Comments +1 added lines, -1 removed lines

@@ -446,7 +446,7 @@
      * Set col data Type
      *
      * @param string, PHPExcel_Cell_DataType
-     * @return PHPExcel_Reader_CSV
+     * @return Csv
      */
     public function setColDataType($colLetter = 'A', $dateType = PHPExcel_Cell_DataType::TYPE_STRING)
     {