PHPOffice / PhpSpreadsheet

src/PhpSpreadsheet/Writer/Html.php

Doc Comments +1 added lines, -1 removed lines

@@ -1188,7 +1188,7 @@
      * @param Worksheet $pSheet \PhpOffice\PhpSpreadsheet\Worksheet
      * @param array $pValues Array containing cells in a row
      * @param int $pRow Row number (0-based)
-     * @param mixed $cellType eg: 'td'
+     * @param string $cellType eg: 'td'
      *
      * @throws WriterException
      *

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

Doc Comments +2 added lines, -2 removed lines

@@ -2664,7 +2664,7 @@ 
 
     /**
      * @param string $cellReference
-     * @param mixed $cellValue
+     * @param boolean $cellValue
      */
     public function saveValueToCache($cellReference, $cellValue)
     {
@@ -2789,7 +2789,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)
     {

src/PhpSpreadsheet/Calculation/Financial.php

Doc Comments +49 added lines, -42 removed lines

@@ -15,7 +15,7 @@ 
      *
      * Returns a boolean TRUE/FALSE indicating if this date is the last date of the month
      *
-     * @param DateTime $testDate The date for testing
+     * @param \DateTime $testDate The date for testing
      *
      * @return bool
      */
@@ -24,6 +24,10 @@ 
         return $testDate->format('d') == $testDate->format('t');
     }
 
+    /**
+     * @param integer $frequency
+     * @param boolean $next
+     */
     private static function couponFirstPeriodDate($settlement, $maturity, $frequency, $next)
     {
         $months = 12 / $frequency;
@@ -45,6 +49,9 @@ 
         return Date::PHPToExcel($result);
     }
 
+    /**
+     * @param integer $frequency
+     */
     private static function isValidFrequency($frequency)
     {
         if (($frequency == 1) || ($frequency == 2) || ($frequency == 4)) {
@@ -126,7 +133,7 @@ 
      *                                    The security settlement date is the date after the issue date
      *                                    when the security is traded to the buyer.
      * @param float $rate the security's annual coupon rate
-     * @param float $par The security's par value.
+     * @param integer $par The security's par value.
      *                                    If you omit par, ACCRINT uses $1,000.
      * @param int $frequency the number of coupon payments per year.
      *                                    Valid frequency values are:
@@ -199,8 +206,8 @@ 
      * @param mixed $issue
      * @param mixed $settlement
      * @param mixed $rate
-     * @param mixed $par
-     * @param mixed $basis
+     * @param integer $par
+     * @param integer $basis
      *
      * @return float
      */
@@ -266,7 +273,7 @@ 
      * @param mixed $salvage
      * @param mixed $period
      * @param mixed $rate
-     * @param mixed $basis
+     * @param integer $basis
      *
      * @return float
      */
@@ -351,7 +358,7 @@ 
      * @param mixed $salvage
      * @param mixed $period
      * @param mixed $rate
-     * @param mixed $basis
+     * @param integer $basis
      *
      * @return float
      */
@@ -421,8 +428,8 @@ 
      *                                        4                European 30/360
      * @param mixed $settlement
      * @param mixed $maturity
-     * @param mixed $frequency
-     * @param mixed $basis
+     * @param integer $frequency
+     * @param integer $basis
      *
      * @return float
      */
@@ -485,7 +492,7 @@ 
      * @param int $frequency
      * @param mixed $settlement
      * @param mixed $maturity
-     * @param mixed $basis
+     * @param integer $basis
      *
      * @return float
      */
@@ -562,8 +569,8 @@ 
      *                                        4                European 30/360
      * @param mixed $settlement
      * @param mixed $maturity
-     * @param mixed $frequency
-     * @param mixed $basis
+     * @param integer $frequency
+     * @param integer $basis
      *
      * @return float
      */
@@ -626,7 +633,7 @@ 
      * @param mixed $settlement
      * @param mixed $maturity
      * @param mixed $frequency
-     * @param mixed $basis
+     * @param integer $basis
      *
      * @return mixed Excel date/time serial value, PHP date/time serial value or PHP date/time object,
      *                        depending on the value of the ReturnDateType flag
@@ -687,8 +694,8 @@ 
      *                                        4                European 30/360
      * @param mixed $settlement
      * @param mixed $maturity
-     * @param mixed $frequency
-     * @param mixed $basis
+     * @param integer $frequency
+     * @param integer $basis
      *
      * @return int
      */
@@ -764,7 +771,7 @@ 
      * @param mixed $settlement
      * @param mixed $maturity
      * @param mixed $frequency
-     * @param mixed $basis
+     * @param integer $basis
      *
      * @return mixed Excel date/time serial value, PHP date/time serial value or PHP date/time object,
      *                        depending on the value of the ReturnDateType flag
@@ -916,7 +923,7 @@ 
      * @param mixed $salvage
      * @param mixed $life
      * @param mixed $period
-     * @param mixed $month
+     * @param integer $month
      *
      * @return float
      */
@@ -991,7 +998,7 @@ 
      * @param mixed $salvage
      * @param mixed $life
      * @param mixed $period
-     * @param mixed $factor
+     * @param double $factor
      *
      * @return float
      */
@@ -1060,7 +1067,7 @@ 
      * @param mixed $maturity
      * @param mixed $price
      * @param mixed $redemption
-     * @param mixed $basis
+     * @param integer $basis
      *
      * @return float
      */
@@ -1179,7 +1186,7 @@ 
      *
      * @category Financial Functions
      *
-     * @param float $nominal_rate Nominal interest rate
+     * @param integer $nominal_rate Nominal interest rate
      * @param int $npery Number of compounding payments per year
      *
      * @return float
@@ -1207,12 +1214,12 @@ 
      *
      * @category Financial Functions
      *
-     * @param float $rate The interest rate per period
+     * @param integer $rate The interest rate per period
      * @param int $nper Total number of payment periods in an annuity
-     * @param float $pmt The payment made each period: it cannot change over the
+     * @param integer $pmt The payment made each period: it cannot change over the
      *                            life of the annuity. Typically, pmt contains principal
      *                            and interest but no other fees or taxes.
-     * @param float $pv present Value, or the lump-sum amount that a series of
+     * @param integer $pv present Value, or the lump-sum amount that a series of
      *                            future payments is worth right now
      * @param int $type A number 0 or 1 and indicates when payments are due:
      *                                0 or omitted    At the end of the period.
@@ -1330,7 +1337,7 @@ 
      * @param int $per Period for which we want to find the interest
      * @param int $nper Number of periods
      * @param float $pv Present Value
-     * @param float $fv Future Value
+     * @param integer $fv Future Value
      * @param int $type Payment type: 0 = at the end of each period, 1 = at the beginning of each period
      *
      * @return float
@@ -1525,7 +1532,7 @@ 
      *
      * Returns the nominal interest rate given the effective rate and the number of compounding payments per year.
      *
-     * @param float $effect_rate Effective interest rate
+     * @param integer $effect_rate Effective interest rate
      * @param int $npery Number of compounding payments per year
      *
      * @return float
@@ -1549,10 +1556,10 @@ 
      *
      * Returns the number of periods for a cash flow with constant periodic payments (annuities), and interest rate.
      *
-     * @param float $rate Interest rate per period
+     * @param integer $rate Interest rate per period
      * @param int $pmt Periodic payment (annuity)
-     * @param float $pv Present Value
-     * @param float $fv Future Value
+     * @param integer $pv Present Value
+     * @param integer $fv Future Value
      * @param int $type Payment type: 0 = at the end of each period, 1 = at the beginning of each period
      *
      * @return float
@@ -1618,10 +1625,10 @@ 
      *
      * Returns the constant payment (annuity) for a cash flow with a constant interest rate.
      *
-     * @param float $rate Interest rate per period
+     * @param integer $rate Interest rate per period
      * @param int $nper Number of periods
-     * @param float $pv Present Value
-     * @param float $fv Future Value
+     * @param integer $pv Present Value
+     * @param integer $fv Future Value
      * @param int $type Payment type: 0 = at the end of each period, 1 = at the beginning of each period
      *
      * @return float
@@ -1656,7 +1663,7 @@ 
      * @param int $per Period for which we want to find the interest
      * @param int $nper Number of periods
      * @param float $pv Present Value
-     * @param float $fv Future Value
+     * @param integer $fv Future Value
      * @param int $type Payment type: 0 = at the end of each period, 1 = at the beginning of each period
      *
      * @return float
@@ -1746,7 +1753,7 @@ 
      * @param mixed $maturity
      * @param mixed $discount
      * @param mixed $redemption
-     * @param mixed $basis
+     * @param integer $basis
      *
      * @return float
      */
@@ -1798,7 +1805,7 @@ 
      * @param mixed $issue
      * @param mixed $rate
      * @param mixed $yield
-     * @param mixed $basis
+     * @param integer $basis
      *
      * @return float
      */
@@ -1852,10 +1859,10 @@ 
      *
      * Returns the Present Value of a cash flow with constant payments and interest rate (annuities).
      *
-     * @param float $rate Interest rate per period
+     * @param integer $rate Interest rate per period
      * @param int $nper Number of periods
-     * @param float $pmt Periodic payment (annuity)
-     * @param float $fv Future Value
+     * @param integer $pmt Periodic payment (annuity)
+     * @param integer $fv Future Value
      * @param int $type Payment type: 0 = at the end of each period, 1 = at the beginning of each period
      *
      * @return float
@@ -1912,9 +1919,9 @@ 
      * @param mixed $nper
      * @param mixed $pmt
      * @param mixed $pv
-     * @param mixed $fv
-     * @param mixed $type
-     * @param mixed $guess
+     * @param double $fv
+     * @param integer $type
+     * @param double $guess
      *
      * @return float
      **/
@@ -1983,7 +1990,7 @@ 
      * @param mixed $maturity
      * @param mixed $investment
      * @param mixed $discount
-     * @param mixed $basis
+     * @param integer $basis
      *
      * @return float
      */
@@ -2353,7 +2360,7 @@ 
      * @param mixed $maturity
      * @param mixed $price
      * @param mixed $redemption
-     * @param mixed $basis
+     * @param integer $basis
      *
      * @return float
      */
@@ -2410,7 +2417,7 @@ 
      * @param mixed $issue
      * @param mixed $rate
      * @param mixed $price
-     * @param mixed $basis
+     * @param integer $basis
      *
      * @return float
      */

src/PhpSpreadsheet/Calculation/Statistical.php

Doc Comments +8 added lines, -13 removed lines

@@ -114,8 +114,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)
     {
@@ -717,8 +717,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
      */
@@ -756,8 +756,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
      */
@@ -1823,7 +1823,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
      */
@@ -2554,7 +2553,6 @@ 
      * @category Statistical Functions
      *
      * @param mixed $args Data values
-     * @param float $entry Percentile value in the range 0..1, inclusive.
      *
      * @return float
      */
@@ -2605,7 +2603,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
      */
@@ -2726,7 +2724,6 @@ 
      * @category Statistical Functions
      *
      * @param mixed $args Data values
-     * @param int $entry Quartile value in the range 1..3, inclusive.
      *
      * @return float
      */
@@ -2759,7 +2756,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
      */
@@ -2901,7 +2898,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
      */
@@ -3365,7 +3361,6 @@ 
      * @category Statistical Functions
      *
      * @param mixed $args Data values
-     * @param float $discard Percentage to discard
      *
      * @return float
      */