PHPOffice / PhpSpreadsheet

src/PhpSpreadsheet/Calculation/MathTrig.php

Doc Comments +11 added lines, -21 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;
@@ -343,7 +347,6 @@ 
      *
      * @category Mathematical and Trigonometric Functions
      *
-     * @param    mixed    $arg,...        Data values
      *
      * @return    int                    Greatest Common Divisor
      */
@@ -452,7 +455,6 @@ 
      *
      * @category Mathematical and Trigonometric Functions
      *
-     * @param    mixed    $arg,...        Data values
      *
      * @return    int        Lowest Common Multiplier
      */
@@ -504,7 +506,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 +824,8 @@ 
      *
      * Computes x raised to the power y.
      *
-     * @param    float        $x
-     * @param    float        $y
+     * @param    integer        $x
+     * @param    integer        $y
      *
      * @return    float
      */
@@ -855,7 +857,6 @@ 
      *
      * @category Mathematical and Trigonometric Functions
      *
-     * @param    mixed        $arg,...        Data values
      *
      * @return    float
      */
@@ -895,9 +896,8 @@ 
      *
      * @category Mathematical and Trigonometric Functions
      *
-     * @param    mixed        $arg,...        Data values
      *
-     * @return    float
+     * @return    integer
      */
     public static function QUOTIENT()
     {
@@ -1035,9 +1035,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
@@ -1181,7 +1178,6 @@ 
      *
      * @category Mathematical and Trigonometric Functions
      *
-     * @param    mixed        $arg,...        Data values
      *
      * @return    float
      */
@@ -1210,12 +1206,11 @@ 
      *
      * @category Mathematical and Trigonometric Functions
      *
-     * @param    mixed        $arg,...        Data values
      * @param    string        $condition        the criteria that defines which cells will be summed
      * @param mixed $aArgs
      * @param mixed $sumArgs
      *
-     * @return    float
+     * @return    integer
      */
     public static function SUMIF($aArgs, $condition, $sumArgs = [])
     {
@@ -1254,10 +1249,7 @@ 
      *
      *    @category Mathematical and Trigonometric Functions
      *
-     *    @param    mixed        $arg,...        Data values
-     *    @param    string        $condition        the criteria that defines which cells will be summed
-     *
-     *    @return    float
+     * @return integer
      */
     public static function SUMIFS()
     {
@@ -1302,7 +1294,6 @@ 
      *
      * @category Mathematical and Trigonometric Functions
      *
-     * @param    mixed        $arg,...        Data values
      *
      * @return    float
      */
@@ -1347,7 +1338,6 @@ 
      *
      * @category Mathematical and Trigonometric Functions
      *
-     * @param    mixed        $arg,...        Data values
      *
      * @return    float
      */
@@ -1446,7 +1436,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, -46 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)
     {
@@ -722,7 +722,6 @@ 
      *
      * @category Statistical Functions
      *
-     * @param    mixed        $arg,...        Data values
      *
      * @return    float
      */
@@ -773,7 +772,6 @@ 
      *
      * @category Statistical Functions
      *
-     * @param    mixed        $arg,...        Data values
      *
      * @return    float
      */
@@ -816,7 +814,6 @@ 
      *
      * @category Statistical Functions
      *
-     * @param    mixed        $arg,...        Data values
      *
      * @return    float
      */
@@ -863,7 +860,6 @@ 
      *
      * @category Mathematical and Trigonometric Functions
      *
-     * @param    mixed        $arg,...        Data values
      * @param    string        $condition        the criteria that defines which cells will be checked
      * @param    mixed[]        $averageArgs    Data values
      * @param mixed $aArgs
@@ -910,8 +906,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
      */
@@ -949,8 +945,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
      */
@@ -1210,7 +1206,6 @@ 
      *
      * @category Statistical Functions
      *
-     * @param    mixed        $arg,...        Data values
      *
      * @return    int
      */
@@ -1244,7 +1239,6 @@ 
      *
      * @category Statistical Functions
      *
-     * @param    mixed        $arg,...        Data values
      *
      * @return    int
      */
@@ -1274,7 +1268,6 @@ 
      *
      * @category Statistical Functions
      *
-     * @param    mixed        $arg,...        Data values
      *
      * @return    int
      */
@@ -1304,7 +1297,6 @@ 
      *
      * @category Statistical Functions
      *
-     * @param    mixed        $arg,...        Data values
      * @param    string        $condition        the criteria that defines which cells will be counted
      * @param mixed $aArgs
      *
@@ -1495,7 +1487,6 @@ 
      *
      * @category Statistical Functions
      *
-     * @param    mixed        $arg,...        Data values
      *
      * @return    float
      */
@@ -1789,7 +1780,6 @@ 
      *
      * @category Statistical Functions
      *
-     * @param    mixed        $arg,...        Data values
      *
      * @return    float
      */
@@ -1855,7 +1845,6 @@ 
      *
      * @category Statistical Functions
      *
-     * @param    mixed        $arg,...        Data values
      *
      * @return    float
      */
@@ -2016,8 +2005,6 @@ 
      *
      * @category Statistical Functions
      *
-     * @param    mixed        $arg,...        Data values
-     * @param    int            $entry            Position (ordered from the largest) in the array or range of data to return
      *
      * @return    float
      */
@@ -2253,7 +2240,6 @@ 
      *
      * @category Statistical Functions
      *
-     * @param    mixed        $arg,...        Data values
      *
      * @return    float
      */
@@ -2289,7 +2275,6 @@ 
      *
      * @category Statistical Functions
      *
-     * @param    mixed        $arg,...        Data values
      *
      * @return    float
      */
@@ -2330,7 +2315,6 @@ 
      *
      * @category Mathematical and Trigonometric Functions
      *
-     * @param    mixed        $arg,...        Data values
      * @param    string        $condition        the criteria that defines which cells will be checked
      * @param mixed $aArgs
      * @param mixed $sumArgs
@@ -2373,7 +2357,6 @@ 
      *
      * @category Statistical Functions
      *
-     * @param    mixed        $arg,...        Data values
      *
      * @return    float
      */
@@ -2417,7 +2400,6 @@ 
      *
      * @category Statistical Functions
      *
-     * @param    mixed        $arg,...        Data values
      *
      * @return    float
      */
@@ -2453,7 +2435,6 @@ 
      *
      * @category Statistical Functions
      *
-     * @param    mixed        $arg,...        Data values
      *
      * @return    float
      */
@@ -2494,7 +2475,6 @@ 
      *
      * @category Mathematical and Trigonometric Functions
      *
-     * @param    mixed        $arg,...        Data values
      * @param    string        $condition        the criteria that defines which cells will be checked
      * @param mixed $aArgs
      * @param mixed $sumArgs
@@ -2574,7 +2554,6 @@ 
      *
      * @category Statistical Functions
      *
-     * @param    mixed        $arg,...        Data values
      *
      * @return    float
      */
@@ -2748,8 +2727,6 @@ 
      *
      * @category Statistical Functions
      *
-     * @param    mixed        $arg,...        Data values
-     * @param    float        $entry            Percentile value in the range 0..1, inclusive.
      *
      * @return    float
      */
@@ -2800,7 +2777,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
      */
@@ -2920,8 +2897,6 @@ 
      *
      * @category Statistical Functions
      *
-     * @param    mixed        $arg,...        Data values
-     * @param    int            $entry            Quartile value in the range 1..3, inclusive.
      *
      * @return    float
      */
@@ -2954,7 +2929,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
      */
@@ -3095,8 +3070,6 @@ 
      *
      * @category Statistical Functions
      *
-     * @param    mixed        $arg,...        Data values
-     * @param    int            $entry            Position (ordered from the smallest) in the array or range of data to return
      *
      * @return    float
      */
@@ -3167,7 +3140,6 @@ 
      *
      * @category Statistical Functions
      *
-     * @param    mixed        $arg,...        Data values
      *
      * @return    float
      */
@@ -3216,7 +3188,6 @@ 
      *
      * @category Statistical Functions
      *
-     * @param    mixed        $arg,...        Data values
      *
      * @return    float
      */
@@ -3268,7 +3239,6 @@ 
      *
      * @category Statistical Functions
      *
-     * @param    mixed        $arg,...        Data values
      *
      * @return    float
      */
@@ -3315,7 +3285,6 @@ 
      *
      * @category Statistical Functions
      *
-     * @param    mixed        $arg,...        Data values
      *
      * @return    float
      */
@@ -3559,8 +3528,6 @@ 
      *
      * @category Statistical Functions
      *
-     * @param    mixed        $arg,...        Data values
-     * @param    float        $discard        Percentage to discard
      *
      * @return    float
      */
@@ -3605,7 +3572,6 @@ 
      *
      * @category Statistical Functions
      *
-     * @param    mixed        $arg,...        Data values
      *
      * @return    float
      */
@@ -3649,7 +3615,6 @@ 
      *
      * @category Statistical Functions
      *
-     * @param    mixed        $arg,...        Data values
      *
      * @return    float
      */
@@ -3702,7 +3667,6 @@ 
      *
      * @category Statistical Functions
      *
-     * @param    mixed        $arg,...        Data values
      *
      * @return    float
      */
@@ -3747,7 +3711,6 @@ 
      *
      * @category Statistical Functions
      *
-     * @param    mixed        $arg,...        Data values
      *
      * @return    float
      */

src/PhpSpreadsheet/Chart/DataSeriesValues.php

Doc Comments +2 added lines, -2 removed lines

@@ -80,9 +80,9 @@
      * Create a new DataSeriesValues object.
      *
      * @param string $dataSource
-     * @param mixed $dataType
+     * @param string $dataType
      * @param null|mixed $formatCode
-     * @param mixed $pointCount
+     * @param integer $pointCount
      * @param mixed $dataValues
      * @param null|mixed $marker
      */

src/PhpSpreadsheet/Chart/PlotArea.php

Doc Comments +1 added lines, -1 removed lines

@@ -64,7 +64,7 @@
     /**
      * Get Number of Plot Groups.
      *
-     * @return array of DataSeries
+     * @return integer of DataSeries
      */
     public function getPlotGroupCount()
     {

src/PhpSpreadsheet/Reader/Xlsx/Theme.php

Doc Comments +3 added lines, -3 removed lines

@@ -57,8 +57,8 @@ 
     /**
      * Create a new Theme.
      *
-     * @param mixed $themeName
-     * @param mixed $colourSchemeName
+     * @param string $themeName
+     * @param string $colourSchemeName
      * @param mixed $colourMap
      */
     public function __construct($themeName, $colourSchemeName, $colourMap)
@@ -92,7 +92,7 @@ 
     /**
      * Get colour Map Value by Position.
      *
-     * @param mixed $index
+     * @param integer $index
      *
      * @return string
      */

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/OLE/PPS/Root.php

Doc Comments +2 added lines, -2 removed lines

@@ -56,7 +56,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 string|resource $filename the name of the file or stream where to save the OLE container
+     * @param string|null $filename the name of the file or stream where to save the OLE container
      *
      * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception
      *
@@ -121,7 +121,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/Shared/PCLZip/PclZip.php

Doc Comments +12 added lines

@@ -1367,6 +1367,10 @@ 
     //     1 on success.
     //     0 on failure.
     // --------------------------------------------------------------------------------
+
+    /**
+     * @param integer $p_size
+     */
     public function privParseOptions(&$p_options_list, $p_size, &$v_result_list, $v_requested_options = false)
     {
         $v_result = 1;
@@ -2218,6 +2222,10 @@ 
     // Description :
     // Parameters :
     // --------------------------------------------------------------------------------
+
+    /**
+     * @param string $p_mode
+     */
     public function privOpenFd($p_mode)
     {
         $v_result = 1;
@@ -3831,6 +3839,10 @@ 
     // Parameters :
     // Return Values :
     // --------------------------------------------------------------------------------
+
+    /**
+     * @param string $p_string
+     */
     public function privExtractFileAsString(&$p_entry, &$p_string, &$p_options)
     {
         $v_result = 1;

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
@@ -2994,7 +2994,7 @@ 
      *
      * @throws Exception
      *
-     * @return objWorksheet
+     * @return Worksheet
      */
     public function setCodeName($pValue = null)
     {