PHPOffice / PhpSpreadsheet

src/PhpSpreadsheet/Calculation/Financial.php

Doc Comments +48 added lines, -41 removed lines

@@ -60,6 +60,10 @@ 
         return $testDate->format('d') == 1;
     }
 
+    /**
+     * @param integer $frequency
+     * @param boolean $next
+     */
     private static function couponFirstPeriodDate($settlement, $maturity, $frequency, $next)
     {
         $months = 12 / $frequency;
@@ -81,6 +85,9 @@ 
         return \PhpOffice\PhpSpreadsheet\Shared\Date::PHPToExcel($result);
     }
 
+    /**
+     * @param integer $frequency
+     */
     private static function isValidFrequency($frequency)
     {
         if (($frequency == 1) || ($frequency == 2) || ($frequency == 4)) {
@@ -159,7 +166,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:
@@ -232,8 +239,8 @@ 
      * @param mixed $issue
      * @param mixed $settlement
      * @param mixed $rate
-     * @param mixed $par
-     * @param mixed $basis
+     * @param integer $par
+     * @param integer $basis
      *
      * @return float
      */
@@ -299,7 +306,7 @@ 
      * @param mixed $salvage
      * @param mixed $period
      * @param mixed $rate
-     * @param mixed $basis
+     * @param integer $basis
      *
      * @return float
      */
@@ -384,7 +391,7 @@ 
      * @param mixed $salvage
      * @param mixed $period
      * @param mixed $rate
-     * @param mixed $basis
+     * @param integer $basis
      *
      * @return float
      */
@@ -454,8 +461,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
      */
@@ -518,7 +525,7 @@ 
      * @param int $frequency
      * @param mixed $settlement
      * @param mixed $maturity
-     * @param mixed $basis
+     * @param integer $basis
      *
      * @return float
      */
@@ -597,8 +604,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
      */
@@ -661,7 +668,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
@@ -722,8 +729,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
      */
@@ -799,7 +806,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
@@ -951,7 +958,7 @@ 
      * @param mixed $salvage
      * @param mixed $life
      * @param mixed $period
-     * @param mixed $month
+     * @param integer $month
      *
      * @return float
      */
@@ -1026,7 +1033,7 @@ 
      * @param mixed $salvage
      * @param mixed $life
      * @param mixed $period
-     * @param mixed $factor
+     * @param double $factor
      *
      * @return float
      */
@@ -1095,7 +1102,7 @@ 
      * @param mixed $maturity
      * @param mixed $price
      * @param mixed $redemption
-     * @param mixed $basis
+     * @param integer $basis
      *
      * @return float
      */
@@ -1214,7 +1221,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
@@ -1242,12 +1249,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.
@@ -1365,7 +1372,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
@@ -1560,7 +1567,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
@@ -1584,10 +1591,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
@@ -1653,10 +1660,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
@@ -1691,7 +1698,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
@@ -1781,7 +1788,7 @@ 
      * @param mixed $maturity
      * @param mixed $discount
      * @param mixed $redemption
-     * @param mixed $basis
+     * @param integer $basis
      *
      * @return float
      */
@@ -1833,7 +1840,7 @@ 
      * @param mixed $issue
      * @param mixed $rate
      * @param mixed $yield
-     * @param mixed $basis
+     * @param integer $basis
      *
      * @return float
      */
@@ -1887,10 +1894,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
@@ -1947,9 +1954,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
      **/
@@ -2018,7 +2025,7 @@ 
      * @param mixed $maturity
      * @param mixed $investment
      * @param mixed $discount
-     * @param mixed $basis
+     * @param integer $basis
      *
      * @return float
      */
@@ -2388,7 +2395,7 @@ 
      * @param mixed $maturity
      * @param mixed $price
      * @param mixed $redemption
-     * @param mixed $basis
+     * @param integer $basis
      *
      * @return float
      */
@@ -2445,7 +2452,7 @@ 
      * @param mixed $issue
      * @param mixed $rate
      * @param mixed $price
-     * @param mixed $basis
+     * @param integer $basis
      *
      * @return float
      */

src/PhpSpreadsheet/Calculation/TextData.php

Doc Comments +1 added lines, -1 removed lines

@@ -169,7 +169,7 @@
      * This function converts a number to text using currency format, with the decimals rounded to the specified place.
      * The format used is $#,##0.00_);($#,##0.00)..
      *
-     * @param float $value The value to format
+     * @param integer $value The value to format
      * @param int $decimals The number of digits to display to the right of the decimal point.
      *                                    If decimals is negative, number is rounded to the left of the decimal point.
      *                                    If you omit decimals, it is assumed to be 2

src/PhpSpreadsheet/Shared/Font.php

Doc Comments +1 added lines, -1 removed lines

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

src/PhpSpreadsheet/Shared/JAMA/EigenvalueDecomposition.php

Doc Comments +2 added lines, -2 removed lines

@@ -819,7 +819,7 @@ 
     /**
      * Return the eigenvector matrix.
      *
-     * @return V
+     * @return Matrix
      */
     public function getV()
     {
@@ -849,7 +849,7 @@ 
     /**
      * Return the block diagonal eigenvalue matrix.
      *
-     * @return D
+     * @return Matrix
      */
     public function getD()
     {

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/JAMA/Matrix.php

Doc Comments +2 added lines, -19 removed lines

@@ -149,10 +149,6 @@ 
      *
      *    Get a submatrix
      *
-     * @param int $i0 Initial row index
-     * @param int $iF Final row index
-     * @param int $j0 Initial column index
-     * @param int $jF Final column index
      *
      * @return Matrix Submatrix
      */
@@ -345,7 +341,7 @@ 
      *
      * @param int $m Row dimension
      * @param int $n Column dimension
-     * @param mixed $c Diagonal value
+     * @param integer $c Diagonal value
      *
      * @return Matrix Diagonal matrix
      */
@@ -429,7 +425,7 @@ 
      *
      *    Sum of diagonal elements
      *
-     * @return float Sum of diagonal elements
+     * @return integer Sum of diagonal elements
      */
     public function trace()
     {
@@ -458,7 +454,6 @@ 
      *
      *    A + B
      *
-     * @param mixed $B Matrix/Array
      *
      * @return Matrix Sum
      */
@@ -500,7 +495,6 @@ 
      *
      *    A = A + B
      *
-     * @param mixed $B Matrix/Array
      *
      * @return Matrix Sum
      */
@@ -556,7 +550,6 @@ 
      *
      *    A - B
      *
-     * @param mixed $B Matrix/Array
      *
      * @return Matrix Sum
      */
@@ -598,7 +591,6 @@ 
      *
      *    A = A - B
      *
-     * @param mixed $B Matrix/Array
      *
      * @return Matrix Sum
      */
@@ -655,7 +647,6 @@ 
      *    Element-by-element multiplication
      *    Cij = Aij * Bij
      *
-     * @param mixed $B Matrix/Array
      *
      * @return Matrix Matrix Cij
      */
@@ -698,7 +689,6 @@ 
      *    Element-by-element multiplication
      *    Aij = Aij * Bij
      *
-     * @param mixed $B Matrix/Array
      *
      * @return Matrix Matrix Aij
      */
@@ -755,7 +745,6 @@ 
      *    Element-by-element right division
      *    A / B
      *
-     * @param Matrix $B Matrix B
      *
      * @return Matrix Division result
      */
@@ -817,7 +806,6 @@ 
      *    Element-by-element right division
      *    Aij = Aij / Bij
      *
-     * @param mixed $B Matrix/Array
      *
      * @return Matrix Matrix Aij
      */
@@ -860,7 +848,6 @@ 
      *    Element-by-element Left division
      *    A / B
      *
-     * @param Matrix $B Matrix B
      *
      * @return Matrix Division result
      */
@@ -903,7 +890,6 @@ 
      *    Element-by-element Left division
      *    Aij = Aij / Bij
      *
-     * @param mixed $B Matrix/Array
      *
      * @return Matrix Matrix Aij
      */
@@ -945,7 +931,6 @@ 
      *
      *    Matrix multiplication
      *
-     * @param mixed $n Matrix/Array/Scalar
      *
      * @return Matrix Product
      */
@@ -1038,7 +1023,6 @@ 
      *
      *    A = A ^ B
      *
-     * @param mixed $B Matrix/Array
      *
      * @return Matrix Sum
      */
@@ -1094,7 +1078,6 @@ 
      *
      *    A = A & B
      *
-     * @param mixed $B Matrix/Array
      *
      * @return Matrix Sum
      */

src/PhpSpreadsheet/Shared/JAMA/SingularValueDecomposition.php

Doc Comments +3 added lines, -3 removed lines

@@ -441,7 +441,7 @@ 
     /**
      * Return the left singular vectors.
      *
-     * @return U
+     * @return Matrix
      */
     public function getU()
     {
@@ -451,7 +451,7 @@ 
     /**
      * Return the right singular vectors.
      *
-     * @return V
+     * @return Matrix
      */
     public function getV()
     {
@@ -471,7 +471,7 @@ 
     /**
      * Return the diagonal matrix of singular values.
      *
-     * @return S
+     * @return Matrix
      */
     public function getS()
     {

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