Completed
Pull Request — develop (#47)
by
unknown
10:56
created
src/PhpSpreadsheet/Calculation.php 1 patch
Doc Comments   +19 added lines, -2 removed lines patch added patch discarded remove patch
@@ -2085,7 +2085,6 @@  discard block
 block discarded – undo
2085 2085
     /**
2086 2086
      * Unset an instance of this class.
2087 2087
      *
2088
-     * @param Spreadsheet $spreadsheet Injected spreadsheet identifying the instance to unset
2089 2088
      */
2090 2089
     public function __destruct()
2091 2090
     {
@@ -2339,6 +2338,10 @@  discard block
 block discarded – undo
2339 2338
         return false;
2340 2339
     }
2341 2340
 
2341
+    /**
2342
+     * @param string $fromSeparator
2343
+     * @param string $toSeparator
2344
+     */
2342 2345
     public static function translateSeparator($fromSeparator, $toSeparator, $formula, &$inBraces)
2343 2346
     {
2344 2347
         $strlen = mb_strlen($formula);
@@ -2679,6 +2682,9 @@  discard block
 block discarded – undo
2679 2682
         return $result;
2680 2683
     }
2681 2684
 
2685
+    /**
2686
+     * @param string $cellReference
2687
+     */
2682 2688
     public function getValueFromCache($cellReference, &$cellValue)
2683 2689
     {
2684 2690
         // Is calculation cacheing enabled?
@@ -2821,7 +2827,7 @@  discard block
 block discarded – undo
2821 2827
      *
2822 2828
      * @param mixed &$matrix matrix operand
2823 2829
      *
2824
-     * @return int[] An array comprising the number of rows, and number of columns
2830
+     * @return integer[] An array comprising the number of rows, and number of columns
2825 2831
      */
2826 2832
     private static function getMatrixDimensions(&$matrix)
2827 2833
     {
@@ -3007,6 +3013,9 @@  discard block
 block discarded – undo
3007 3013
         }
3008 3014
     }
3009 3015
 
3016
+    /**
3017
+     * @param string $formula
3018
+     */
3010 3019
     private function convertMatrixReferences($formula)
3011 3020
     {
3012 3021
         static $matrixReplaceFrom = ['{', ';', '}'];
@@ -3095,6 +3104,10 @@  discard block
 block discarded – undo
3095 3104
     ];
3096 3105
 
3097 3106
     // Convert infix to postfix notation
3107
+
3108
+    /**
3109
+     * @param string $formula
3110
+     */
3098 3111
     private function _parseFormula($formula, Cell $pCell = null)
3099 3112
     {
3100 3113
         if (($formula = $this->convertMatrixReferences(trim($formula))) === false) {
@@ -3832,6 +3845,9 @@  discard block
 block discarded – undo
3832 3845
         return true;
3833 3846
     }
3834 3847
 
3848
+    /**
3849
+     * @param string|null $cellID
3850
+     */
3835 3851
     private function executeBinaryComparisonOperation($cellID, $operand1, $operand2, $operation, &$stack, $recursingArrays = false)
3836 3852
     {
3837 3853
         //    If we're dealing with matrix operations, we want a matrix result
@@ -3972,6 +3988,7 @@  discard block
 block discarded – undo
3972 3988
 
3973 3989
     /**
3974 3990
      * @param string $matrixFunction
3991
+     * @param string|null $cellID
3975 3992
      */
3976 3993
     private function executeNumericBinaryOperation($cellID, $operand1, $operand2, $operation, $matrixFunction, &$stack)
3977 3994
     {
Please login to merge, or discard this patch.
src/PhpSpreadsheet/Calculation/DateTime.php 1 patch
Doc Comments   +16 added lines, -16 removed lines patch added patch discarded remove patch
@@ -473,7 +473,7 @@  discard block
 block discarded – undo
473 473
      *
474 474
      * @category Date/Time Functions
475 475
      *
476
-     * @param string $dateValue Text that represents a date in a Microsoft Excel date format.
476
+     * @param integer $dateValue Text that represents a date in a Microsoft Excel date format.
477 477
      *                          For example, "1/30/2008" or "30-Jan-2008" are text strings within
478 478
      *                          quotation marks that represent dates. Using the default date
479 479
      *                          system in Excel for Windows, date_text must represent a date from
@@ -660,9 +660,9 @@  discard block
 block discarded – undo
660 660
     /**
661 661
      * DATEDIF.
662 662
      *
663
-     * @param mixed  $startDate Excel date serial value, PHP date/time stamp, PHP DateTime object
663
+     * @param integer  $startDate Excel date serial value, PHP date/time stamp, PHP DateTime object
664 664
      *                          or a standard date string
665
-     * @param mixed  $endDate   Excel date serial value, PHP date/time stamp, PHP DateTime object
665
+     * @param integer  $endDate   Excel date serial value, PHP date/time stamp, PHP DateTime object
666 666
      *                          or a standard date string
667 667
      * @param string $unit
668 668
      *
@@ -786,9 +786,9 @@  discard block
 block discarded – undo
786 786
      *
787 787
      * @category Date/Time Functions
788 788
      *
789
-     * @param mixed $startDate Excel date serial value (float), PHP date timestamp (integer),
789
+     * @param integer $startDate Excel date serial value (float), PHP date timestamp (integer),
790 790
      *                         PHP DateTime object, or a standard date string
791
-     * @param mixed $endDate   Excel date serial value (float), PHP date timestamp (integer),
791
+     * @param integer $endDate   Excel date serial value (float), PHP date timestamp (integer),
792 792
      *                         PHP DateTime object, or a standard date string
793 793
      * @param bool  $method    US or European Method
794 794
      *                         FALSE or omitted: U.S. (NASD) method. If the starting date is
@@ -847,9 +847,9 @@  discard block
 block discarded – undo
847 847
      *
848 848
      * @category Date/Time Functions
849 849
      *
850
-     * @param mixed $startDate Excel date serial value (float), PHP date timestamp (integer),
850
+     * @param integer $startDate Excel date serial value (float), PHP date timestamp (integer),
851 851
      *                         PHP DateTime object, or a standard date string
852
-     * @param mixed $endDate   Excel date serial value (float), PHP date timestamp (integer),
852
+     * @param integer $endDate   Excel date serial value (float), PHP date timestamp (integer),
853 853
      *                         PHP DateTime object, or a standard date string
854 854
      * @param int   $method    Method used for the calculation
855 855
      *                         0 or omitted    US (NASD) 30/360
@@ -1138,7 +1138,7 @@  discard block
 block discarded – undo
1138 1138
      * Excel Function:
1139 1139
      *        DAY(dateValue)
1140 1140
      *
1141
-     * @param mixed $dateValue Excel date serial value (float), PHP date timestamp (integer),
1141
+     * @param integer $dateValue Excel date serial value (float), PHP date timestamp (integer),
1142 1142
      *                         PHP DateTime object, or a standard date string
1143 1143
      *
1144 1144
      * @return int Day of the month
@@ -1249,7 +1249,7 @@  discard block
 block discarded – undo
1249 1249
      * Excel Function:
1250 1250
      *        WEEKNUM(dateValue[,style])
1251 1251
      *
1252
-     * @param mixed $dateValue Excel date serial value (float), PHP date timestamp (integer),
1252
+     * @param integer $dateValue Excel date serial value (float), PHP date timestamp (integer),
1253 1253
      *                         PHP DateTime object, or a standard date string
1254 1254
      * @param int   $method    Week begins on Sunday or Monday
1255 1255
      *                         1 or omitted    Week begins on Sunday.
@@ -1302,7 +1302,7 @@  discard block
 block discarded – undo
1302 1302
      * Excel Function:
1303 1303
      *        MONTH(dateValue)
1304 1304
      *
1305
-     * @param mixed $dateValue Excel date serial value (float), PHP date timestamp (integer),
1305
+     * @param integer $dateValue Excel date serial value (float), PHP date timestamp (integer),
1306 1306
      *                         PHP DateTime object, or a standard date string
1307 1307
      *
1308 1308
      * @return int Month of the year
@@ -1335,7 +1335,7 @@  discard block
 block discarded – undo
1335 1335
      * Excel Function:
1336 1336
      *        YEAR(dateValue)
1337 1337
      *
1338
-     * @param mixed $dateValue Excel date serial value (float), PHP date timestamp (integer),
1338
+     * @param integer $dateValue Excel date serial value (float), PHP date timestamp (integer),
1339 1339
      *                         PHP DateTime object, or a standard date string
1340 1340
      *
1341 1341
      * @return int Year
@@ -1367,7 +1367,7 @@  discard block
 block discarded – undo
1367 1367
      * Excel Function:
1368 1368
      *        HOUR(timeValue)
1369 1369
      *
1370
-     * @param mixed $timeValue Excel date serial value (float), PHP date timestamp (integer),
1370
+     * @param integer $timeValue Excel date serial value (float), PHP date timestamp (integer),
1371 1371
      *                         PHP DateTime object, or a standard time string
1372 1372
      *
1373 1373
      * @return int Hour
@@ -1408,7 +1408,7 @@  discard block
 block discarded – undo
1408 1408
      * Excel Function:
1409 1409
      *        MINUTE(timeValue)
1410 1410
      *
1411
-     * @param mixed $timeValue Excel date serial value (float), PHP date timestamp (integer),
1411
+     * @param integer $timeValue Excel date serial value (float), PHP date timestamp (integer),
1412 1412
      *                         PHP DateTime object, or a standard time string
1413 1413
      *
1414 1414
      * @return int Minute
@@ -1449,7 +1449,7 @@  discard block
 block discarded – undo
1449 1449
      * Excel Function:
1450 1450
      *        SECOND(timeValue)
1451 1451
      *
1452
-     * @param mixed $timeValue Excel date serial value (float), PHP date timestamp (integer),
1452
+     * @param integer $timeValue Excel date serial value (float), PHP date timestamp (integer),
1453 1453
      *                         PHP DateTime object, or a standard time string
1454 1454
      *
1455 1455
      * @return int Second
@@ -1492,7 +1492,7 @@  discard block
 block discarded – undo
1492 1492
      * Excel Function:
1493 1493
      *        EDATE(dateValue,adjustmentMonths)
1494 1494
      *
1495
-     * @param mixed $dateValue        Excel date serial value (float), PHP date timestamp (integer),
1495
+     * @param integer $dateValue        Excel date serial value (float), PHP date timestamp (integer),
1496 1496
      *                                PHP DateTime object, or a standard date string
1497 1497
      * @param int   $adjustmentMonths The number of months before or after start_date.
1498 1498
      *                                A positive value for months yields a future date;
@@ -1538,7 +1538,7 @@  discard block
 block discarded – undo
1538 1538
      * Excel Function:
1539 1539
      *        EOMONTH(dateValue,adjustmentMonths)
1540 1540
      *
1541
-     * @param mixed $dateValue        Excel date serial value (float), PHP date timestamp (integer),
1541
+     * @param integer $dateValue        Excel date serial value (float), PHP date timestamp (integer),
1542 1542
      *                                PHP DateTime object, or a standard date string
1543 1543
      * @param int   $adjustmentMonths The number of months before or after start_date.
1544 1544
      *                                A positive value for months yields a future date;
Please login to merge, or discard this patch.
src/PhpSpreadsheet/Calculation/Engineering.php 1 patch
Doc Comments   +3 added lines, -5 removed lines patch added patch discarded remove patch
@@ -1855,7 +1855,7 @@  discard block
 block discarded – undo
1855 1855
      *
1856 1856
      * @param string $complexNumber The complex number for which you want the real coefficient
1857 1857
      *
1858
-     * @return float
1858
+     * @return string
1859 1859
      */
1860 1860
     public static function IMREAL($complexNumber)
1861 1861
     {
@@ -2289,7 +2289,6 @@  discard block
 block discarded – undo
2289 2289
      * Excel Function:
2290 2290
      *        IMSUM(complexNumber[,complexNumber[,...]])
2291 2291
      *
2292
-     * @param string $complexNumber,... Series of complex numbers to add
2293 2292
      *
2294 2293
      * @return string
2295 2294
      */
@@ -2329,7 +2328,6 @@  discard block
 block discarded – undo
2329 2328
      * Excel Function:
2330 2329
      *        IMPRODUCT(complexNumber[,complexNumber[,...]])
2331 2330
      *
2332
-     * @param string $complexNumber,... Series of complex numbers to multiply
2333 2331
      *
2334 2332
      * @return string
2335 2333
      */
@@ -2373,7 +2371,7 @@  discard block
 block discarded – undo
2373 2371
      *        DELTA(a[,b])
2374 2372
      *
2375 2373
      * @param float $a The first number
2376
-     * @param float $b The second number. If omitted, b is assumed to be zero
2374
+     * @param integer $b The second number. If omitted, b is assumed to be zero
2377 2375
      *
2378 2376
      * @return int
2379 2377
      */
@@ -2396,7 +2394,7 @@  discard block
 block discarded – undo
2396 2394
      *    functions you calculate the count of values that exceed a threshold.
2397 2395
      *
2398 2396
      * @param float $number The value to test against step
2399
-     * @param float $step   The threshold value.
2397
+     * @param integer $step   The threshold value.
2400 2398
      *                      If you omit a value for step, GESTEP uses zero
2401 2399
      *
2402 2400
      * @return int
Please login to merge, or discard this patch.
src/PhpSpreadsheet/Calculation/Financial.php 1 patch
Doc Comments   +27 added lines, -17 removed lines patch added patch discarded remove patch
@@ -62,6 +62,10 @@  discard block
 block discarded – undo
62 62
         return $testDate->format('d') == 1;
63 63
     }
64 64
 
65
+    /**
66
+     * @param integer $frequency
67
+     * @param boolean $next
68
+     */
65 69
     private static function couponFirstPeriodDate($settlement, $maturity, $frequency, $next)
66 70
     {
67 71
         $months = 12 / $frequency;
@@ -83,6 +87,9 @@  discard block
 block discarded – undo
83 87
         return \PhpOffice\PhpSpreadsheet\Shared\Date::PHPToExcel($result);
84 88
     }
85 89
 
90
+    /**
91
+     * @param integer $frequency
92
+     */
86 93
     private static function isValidFrequency($frequency)
87 94
     {
88 95
         if (($frequency == 1) || ($frequency == 2) || ($frequency == 4)) {
@@ -161,7 +168,7 @@  discard block
 block discarded – undo
161 168
      *                             The security settlement date is the date after the issue date
162 169
      *                             when the security is traded to the buyer
163 170
      * @param float $rate          The security's annual coupon rate
164
-     * @param float $par           The security's par value.
171
+     * @param integer $par           The security's par value.
165 172
      *                             If you omit par, ACCRINT uses $1,000
166 173
      * @param int   $frequency     the number of coupon payments per year.
167 174
      *                             Valid frequency values are:
@@ -435,6 +442,7 @@  discard block
 block discarded – undo
435 442
      *                                        2                Actual/360
436 443
      *                                        3                Actual/365
437 444
      *                                        4                European 30/360
445
+     * @param integer $frequency
438 446
      *
439 447
      * @return float
440 448
      */
@@ -571,6 +579,7 @@  discard block
 block discarded – undo
571 579
      *                                        2                Actual/360
572 580
      *                                        3                Actual/365
573 581
      *                                        4                European 30/360
582
+     * @param integer $frequency
574 583
      *
575 584
      * @return float
576 585
      */
@@ -688,6 +697,7 @@  discard block
 block discarded – undo
688 697
      *                                        2                Actual/360
689 698
      *                                        3                Actual/365
690 699
      *                                        4                European 30/360
700
+     * @param integer $frequency
691 701
      *
692 702
      * @return int
693 703
      */
@@ -1159,7 +1169,7 @@  discard block
 block discarded – undo
1159 1169
      *
1160 1170
      * @category Financial Functions
1161 1171
      *
1162
-     * @param float $nominal_rate Nominal interest rate
1172
+     * @param integer $nominal_rate Nominal interest rate
1163 1173
      * @param int   $npery        Number of compounding payments per year
1164 1174
      *
1165 1175
      * @return float
@@ -1187,12 +1197,12 @@  discard block
 block discarded – undo
1187 1197
      *
1188 1198
      * @category Financial Functions
1189 1199
      *
1190
-     * @param float $rate The interest rate per period
1200
+     * @param integer $rate The interest rate per period
1191 1201
      * @param int   $nper Total number of payment periods in an annuity
1192
-     * @param float $pmt  The payment made each period: it cannot change over the
1202
+     * @param integer $pmt  The payment made each period: it cannot change over the
1193 1203
      *                    life of the annuity. Typically, pmt contains principal
1194 1204
      *                    and interest but no other fees or taxes
1195
-     * @param float $pv   Present Value, or the lump-sum amount that a series of
1205
+     * @param integer $pv   Present Value, or the lump-sum amount that a series of
1196 1206
      *                    future payments is worth right now
1197 1207
      * @param int   $type A number 0 or 1 and indicates when payments are due:
1198 1208
      *                    0 or omitted    At the end of the period.
@@ -1310,7 +1320,7 @@  discard block
 block discarded – undo
1310 1320
      * @param int   $per  Period for which we want to find the interest
1311 1321
      * @param int   $nper Number of periods
1312 1322
      * @param float $pv   Present Value
1313
-     * @param float $fv   Future Value
1323
+     * @param integer $fv   Future Value
1314 1324
      * @param int   $type Payment type: 0 = at the end of each period, 1 = at the beginning of each period
1315 1325
      *
1316 1326
      * @return float
@@ -1505,7 +1515,7 @@  discard block
 block discarded – undo
1505 1515
      *
1506 1516
      * Returns the nominal interest rate given the effective rate and the number of compounding payments per year.
1507 1517
      *
1508
-     * @param float $effect_rate Effective interest rate
1518
+     * @param integer $effect_rate Effective interest rate
1509 1519
      * @param int   $npery       Number of compounding payments per year
1510 1520
      *
1511 1521
      * @return float
@@ -1529,10 +1539,10 @@  discard block
 block discarded – undo
1529 1539
      *
1530 1540
      * Returns the number of periods for a cash flow with constant periodic payments (annuities), and interest rate.
1531 1541
      *
1532
-     * @param float $rate Interest rate per period
1542
+     * @param integer $rate Interest rate per period
1533 1543
      * @param int   $pmt  Periodic payment (annuity)
1534
-     * @param float $pv   Present Value
1535
-     * @param float $fv   Future Value
1544
+     * @param integer $pv   Present Value
1545
+     * @param integer $fv   Future Value
1536 1546
      * @param int   $type Payment type: 0 = at the end of each period, 1 = at the beginning of each period
1537 1547
      *
1538 1548
      * @return float
@@ -1598,10 +1608,10 @@  discard block
 block discarded – undo
1598 1608
      *
1599 1609
      * Returns the constant payment (annuity) for a cash flow with a constant interest rate.
1600 1610
      *
1601
-     * @param float $rate Interest rate per period
1611
+     * @param integer $rate Interest rate per period
1602 1612
      * @param int   $nper Number of periods
1603
-     * @param float $pv   Present Value
1604
-     * @param float $fv   Future Value
1613
+     * @param integer $pv   Present Value
1614
+     * @param integer $fv   Future Value
1605 1615
      * @param int   $type Payment type: 0 = at the end of each period, 1 = at the beginning of each period
1606 1616
      *
1607 1617
      * @return float
@@ -1636,7 +1646,7 @@  discard block
 block discarded – undo
1636 1646
      * @param int   $per  Period for which we want to find the interest
1637 1647
      * @param int   $nper Number of periods
1638 1648
      * @param float $pv   Present Value
1639
-     * @param float $fv   Future Value
1649
+     * @param integer $fv   Future Value
1640 1650
      * @param int   $type Payment type: 0 = at the end of each period, 1 = at the beginning of each period
1641 1651
      *
1642 1652
      * @return float
@@ -1821,10 +1831,10 @@  discard block
 block discarded – undo
1821 1831
      *
1822 1832
      * Returns the Present Value of a cash flow with constant payments and interest rate (annuities).
1823 1833
      *
1824
-     * @param float $rate Interest rate per period
1834
+     * @param integer $rate Interest rate per period
1825 1835
      * @param int   $nper Number of periods
1826
-     * @param float $pmt  Periodic payment (annuity)
1827
-     * @param float $fv   Future Value
1836
+     * @param integer $pmt  Periodic payment (annuity)
1837
+     * @param integer $fv   Future Value
1828 1838
      * @param int   $type Payment type: 0 = at the end of each period, 1 = at the beginning of each period
1829 1839
      *
1830 1840
      * @return float
Please login to merge, or discard this patch.
src/PhpSpreadsheet/Calculation/FormulaParser.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -119,7 +119,7 @@
 block discarded – undo
119 119
      *
120 120
      * @throws Exception
121 121
      *
122
-     * @return string
122
+     * @return FormulaToken
123 123
      */
124 124
     public function getToken($pId = 0)
125 125
     {
Please login to merge, or discard this patch.
src/PhpSpreadsheet/Calculation/Logical.php 1 patch
Doc Comments   +2 added lines, -4 removed lines patch added patch discarded remove patch
@@ -80,7 +80,6 @@  discard block
 block discarded – undo
80 80
      *
81 81
      * @category Logical Functions
82 82
      *
83
-     * @param mixed $arg,... Data values
84 83
      *
85 84
      * @return string|bool The logical AND of the arguments
86 85
      */
@@ -137,7 +136,6 @@  discard block
 block discarded – undo
137 136
      *
138 137
      * @category Logical Functions
139 138
      *
140
-     * @param mixed $arg,... Data values
141 139
      *
142 140
      * @return string|bool The logical OR of the arguments
143 141
      */
@@ -241,8 +239,8 @@  discard block
 block discarded – undo
241 239
      *
242 240
      * @category Logical Functions
243 241
      *
244
-     * @param mixed $condition     Condition to evaluate
245
-     * @param mixed $returnIfTrue  Value to return when condition is true
242
+     * @param boolean $condition     Condition to evaluate
243
+     * @param integer $returnIfTrue  Value to return when condition is true
246 244
      * @param mixed $returnIfFalse Optional value to return when condition is false
247 245
      *
248 246
      * @return mixed The value of returnIfTrue or returnIfFalse determined by condition
Please login to merge, or discard this patch.
src/PhpSpreadsheet/Calculation/LookupRef.php 1 patch
Doc Comments   +4 added lines, -4 removed lines patch added patch discarded remove patch
@@ -38,7 +38,7 @@  discard block
 block discarded – undo
38 38
      *
39 39
      * @param    row                Row number to use in the cell reference
40 40
      * @param    column            Column number to use in the cell reference
41
-     * @param    relativity        Flag indicating the type of reference to return
41
+     * @param    relativity        integer indicating the type of reference to return
42 42
      *                                1 or omitted    Absolute
43 43
      *                                2                Absolute row; relative column
44 44
      *                                3                Relative row; absolute column
@@ -357,7 +357,7 @@  discard block
 block discarded – undo
357 357
      *
358 358
      * @param    cellAddress        The reference from which you want to base the offset. Reference must refer to a cell or
359 359
      *                                range of adjacent cells; otherwise, OFFSET returns the #VALUE! error value
360
-     * @param    rows            The number of rows, up or down, that you want the upper-left cell to refer to.
360
+     * @param    rows            integer number of rows, up or down, that you want the upper-left cell to refer to.
361 361
      *                                Using 5 as the rows argument specifies that the upper-left cell in the reference is
362 362
      *                                five rows below reference. Rows can be positive (which means below the starting reference)
363 363
      *                                or negative (which means above the starting reference)
@@ -495,7 +495,7 @@  discard block
 block discarded – undo
495 495
      *
496 496
      * @param    lookup_value    The value that you want to match in lookup_array
497 497
      * @param    lookup_array    The range of cells being searched
498
-     * @param    match_type        The number -1, 0, or 1. -1 means above, 0 means exact match, 1 means below. If match_type is 1 or -1, the list has to be ordered
498
+     * @param    match_type        integer number -1, 0, or 1. -1 means above, 0 means exact match, 1 means below. If match_type is 1 or -1, the list has to be ordered
499 499
      *
500 500
      * @return int The relative position of the found item
501 501
      */
@@ -688,7 +688,7 @@  discard block
 block discarded – undo
688 688
      *
689 689
      * @param    lookup_value    The value that you want to match in lookup_array
690 690
      * @param    lookup_array    The range of cells being searched
691
-     * @param    index_number    The column number in table_array from which the matching value must be returned. The first column is 1
691
+     * @param    index_number    integer column number in table_array from which the matching value must be returned. The first column is 1
692 692
      * @param    not_exact_match    Determines if you are looking for an exact match based on lookup_value
693 693
      *
694 694
      * @return mixed The value of the found cell
Please login to merge, or discard this patch.
src/PhpSpreadsheet/Calculation/MathTrig.php 1 patch
Doc Comments   +11 added lines, -21 removed lines patch added patch discarded remove patch
@@ -53,6 +53,10 @@  discard block
 block discarded – undo
53 53
         }
54 54
     }
55 55
 
56
+    /**
57
+     * @param integer $num
58
+     * @param integer $n
59
+     */
56 60
     private static function romanCut($num, $n)
57 61
     {
58 62
         return ($num - ($num % $n)) / $n;
@@ -344,7 +348,6 @@  discard block
 block discarded – undo
344 348
      *
345 349
      * @category Mathematical and Trigonometric Functions
346 350
      *
347
-     * @param mixed $arg,... Data values
348 351
      *
349 352
      * @return int Greatest Common Divisor
350 353
      */
@@ -454,7 +457,6 @@  discard block
 block discarded – undo
454 457
      *
455 458
      * @category Mathematical and Trigonometric Functions
456 459
      *
457
-     * @param mixed $arg,... Data values
458 460
      *
459 461
      * @return int Lowest Common Multiplier
460 462
      */
@@ -506,7 +508,7 @@  discard block
 block discarded – undo
506 508
      * @category Mathematical and Trigonometric Functions
507 509
      *
508 510
      * @param float $number The positive real number for which you want the logarithm
509
-     * @param float $base   The base of the logarithm. If base is omitted, it is assumed to be 10
511
+     * @param integer $base   The base of the logarithm. If base is omitted, it is assumed to be 10
510 512
      *
511 513
      * @return float
512 514
      */
@@ -824,8 +826,8 @@  discard block
 block discarded – undo
824 826
      *
825 827
      * Computes x raised to the power y.
826 828
      *
827
-     * @param float $x
828
-     * @param float $y
829
+     * @param integer $x
830
+     * @param integer $y
829 831
      *
830 832
      * @return float
831 833
      */
@@ -857,7 +859,6 @@  discard block
 block discarded – undo
857 859
      *
858 860
      * @category Mathematical and Trigonometric Functions
859 861
      *
860
-     * @param mixed $arg,... Data values
861 862
      *
862 863
      * @return float
863 864
      */
@@ -897,9 +898,8 @@  discard block
 block discarded – undo
897 898
      *
898 899
      * @category Mathematical and Trigonometric Functions
899 900
      *
900
-     * @param mixed $arg,... Data values
901 901
      *
902
-     * @return float
902
+     * @return integer
903 903
      */
904 904
     public static function QUOTIENT()
905 905
     {
@@ -1037,9 +1037,6 @@  discard block
 block discarded – undo
1037 1037
      *
1038 1038
      * Returns the sum of a power series
1039 1039
      *
1040
-     * @param float $x Input value to the power series
1041
-     * @param float $n Initial power to which you want to raise $x
1042
-     * @param float $m Step by which to increase $n for each term in the series
1043 1040
      * @param    array of mixed        Data Series
1044 1041
      *
1045 1042
      * @return float
@@ -1183,7 +1180,6 @@  discard block
 block discarded – undo
1183 1180
      *
1184 1181
      * @category Mathematical and Trigonometric Functions
1185 1182
      *
1186
-     * @param mixed $arg,... Data values
1187 1183
      *
1188 1184
      * @return float
1189 1185
      */
@@ -1212,10 +1208,9 @@  discard block
 block discarded – undo
1212 1208
      *
1213 1209
      * @category Mathematical and Trigonometric Functions
1214 1210
      *
1215
-     * @param mixed  $arg,...   Data values
1216 1211
      * @param string $condition The criteria that defines which cells will be summed
1217 1212
      *
1218
-     * @return float
1213
+     * @return integer
1219 1214
      */
1220 1215
     public static function SUMIF($aArgs, $condition, $sumArgs = [])
1221 1216
     {
@@ -1254,10 +1249,7 @@  discard block
 block discarded – undo
1254 1249
      *
1255 1250
      *    @category Mathematical and Trigonometric Functions
1256 1251
      *
1257
-     *    @param    mixed        $arg,...        Data values
1258
-     *    @param    string        $condition        The criteria that defines which cells will be summed
1259
-     *
1260
-     *    @return    float
1252
+     * @return integer
1261 1253
      */
1262 1254
     public static function SUMIFS()
1263 1255
     {
@@ -1302,7 +1294,6 @@  discard block
 block discarded – undo
1302 1294
      *
1303 1295
      * @category Mathematical and Trigonometric Functions
1304 1296
      *
1305
-     * @param mixed $arg,... Data values
1306 1297
      *
1307 1298
      * @return float
1308 1299
      */
@@ -1347,7 +1338,6 @@  discard block
 block discarded – undo
1347 1338
      *
1348 1339
      * @category Mathematical and Trigonometric Functions
1349 1340
      *
1350
-     * @param mixed $arg,... Data values
1351 1341
      *
1352 1342
      * @return float
1353 1343
      */
@@ -1446,7 +1436,7 @@  discard block
 block discarded – undo
1446 1436
      *
1447 1437
      * Truncates value to the number of fractional digits by number_digits.
1448 1438
      *
1449
-     * @param float $value
1439
+     * @param integer $value
1450 1440
      * @param int   $digits
1451 1441
      *
1452 1442
      * @return float Truncated value
Please login to merge, or discard this patch.
src/PhpSpreadsheet/Calculation/Statistical.php 1 patch
Doc Comments   +5 added lines, -40 removed lines patch added patch discarded remove patch
@@ -130,7 +130,7 @@  discard block
 block discarded – undo
130 130
      * @param p require p>0
131 131
      * @param q require q>0
132 132
      *
133
-     * @return 0 if p<=0, q<=0 or p+q>2.55E305 to avoid errors and over/underflow
133
+     * @return double if p<=0, q<=0 or p+q>2.55E305 to avoid errors and over/underflow
134 134
      *
135 135
      * @author Jaco van Kooten
136 136
      */
@@ -154,6 +154,8 @@  discard block
 block discarded – undo
154 154
      * Based on an idea from Numerical Recipes (W.H. Press et al, 1992).
155 155
      *
156 156
      * @author Jaco van Kooten
157
+     * @param double $p
158
+     * @param double $q
157 159
      */
158 160
     private static function betaFraction($x, $p, $q)
159 161
     {
@@ -711,7 +713,6 @@  discard block
 block discarded – undo
711 713
      *
712 714
      * @category Statistical Functions
713 715
      *
714
-     * @param mixed $arg,... Data values
715 716
      *
716 717
      * @return float
717 718
      */
@@ -762,7 +763,6 @@  discard block
 block discarded – undo
762 763
      *
763 764
      * @category Statistical Functions
764 765
      *
765
-     * @param mixed $arg,... Data values
766 766
      *
767 767
      * @return float
768 768
      */
@@ -805,7 +805,6 @@  discard block
 block discarded – undo
805 805
      *
806 806
      * @category Statistical Functions
807 807
      *
808
-     * @param mixed $arg,... Data values
809 808
      *
810 809
      * @return float
811 810
      */
@@ -852,7 +851,6 @@  discard block
 block discarded – undo
852 851
      *
853 852
      * @category Mathematical and Trigonometric Functions
854 853
      *
855
-     * @param mixed   $arg,...     Data values
856 854
      * @param string  $condition   The criteria that defines which cells will be checked
857 855
      * @param mixed[] $averageArgs Data values
858 856
      *
@@ -935,8 +933,8 @@  discard block
 block discarded – undo
935 933
      * @param float $probability Probability at which you want to evaluate the distribution
936 934
      * @param float $alpha       Parameter to the distribution
937 935
      * @param float $beta        Parameter to the distribution
938
-     * @param float $rMin        Minimum value
939
-     * @param float $rMax        Maximum value
936
+     * @param integer $rMin        Minimum value
937
+     * @param integer $rMax        Maximum value
940 938
      *
941 939
      * @return float
942 940
      */
@@ -1194,7 +1192,6 @@  discard block
 block discarded – undo
1194 1192
      *
1195 1193
      * @category Statistical Functions
1196 1194
      *
1197
-     * @param mixed $arg,... Data values
1198 1195
      *
1199 1196
      * @return int
1200 1197
      */
@@ -1228,7 +1225,6 @@  discard block
 block discarded – undo
1228 1225
      *
1229 1226
      * @category Statistical Functions
1230 1227
      *
1231
-     * @param mixed $arg,... Data values
1232 1228
      *
1233 1229
      * @return int
1234 1230
      */
@@ -1258,7 +1254,6 @@  discard block
 block discarded – undo
1258 1254
      *
1259 1255
      * @category Statistical Functions
1260 1256
      *
1261
-     * @param mixed $arg,... Data values
1262 1257
      *
1263 1258
      * @return int
1264 1259
      */
@@ -1288,7 +1283,6 @@  discard block
 block discarded – undo
1288 1283
      *
1289 1284
      * @category Statistical Functions
1290 1285
      *
1291
-     * @param mixed  $arg,...   Data values
1292 1286
      * @param string $condition The criteria that defines which cells will be counted
1293 1287
      *
1294 1288
      * @return int
@@ -1476,7 +1470,6 @@  discard block
 block discarded – undo
1476 1470
      *
1477 1471
      * @category Statistical Functions
1478 1472
      *
1479
-     * @param mixed $arg,... Data values
1480 1473
      *
1481 1474
      * @return float
1482 1475
      */
@@ -1767,7 +1760,6 @@  discard block
 block discarded – undo
1767 1760
      *
1768 1761
      * @category Statistical Functions
1769 1762
      *
1770
-     * @param mixed $arg,... Data values
1771 1763
      *
1772 1764
      * @return float
1773 1765
      */
@@ -1829,7 +1821,6 @@  discard block
 block discarded – undo
1829 1821
      *
1830 1822
      * @category Statistical Functions
1831 1823
      *
1832
-     * @param mixed $arg,... Data values
1833 1824
      *
1834 1825
      * @return float
1835 1826
      */
@@ -1988,8 +1979,6 @@  discard block
 block discarded – undo
1988 1979
      *
1989 1980
      * @category Statistical Functions
1990 1981
      *
1991
-     * @param mixed $arg,... Data values
1992
-     * @param int   $entry   Position (ordered from the largest) in the array or range of data to return
1993 1982
      *
1994 1983
      * @return float
1995 1984
      */
@@ -2217,7 +2206,6 @@  discard block
 block discarded – undo
2217 2206
      *
2218 2207
      * @category Statistical Functions
2219 2208
      *
2220
-     * @param mixed $arg,... Data values
2221 2209
      *
2222 2210
      * @return float
2223 2211
      */
@@ -2253,7 +2241,6 @@  discard block
 block discarded – undo
2253 2241
      *
2254 2242
      * @category Statistical Functions
2255 2243
      *
2256
-     * @param mixed $arg,... Data values
2257 2244
      *
2258 2245
      * @return float
2259 2246
      */
@@ -2294,7 +2281,6 @@  discard block
 block discarded – undo
2294 2281
      *
2295 2282
      * @category Mathematical and Trigonometric Functions
2296 2283
      *
2297
-     * @param mixed  $arg,...   Data values
2298 2284
      * @param string $condition The criteria that defines which cells will be checked
2299 2285
      *
2300 2286
      * @return float
@@ -2335,7 +2321,6 @@  discard block
 block discarded – undo
2335 2321
      *
2336 2322
      * @category Statistical Functions
2337 2323
      *
2338
-     * @param mixed $arg,... Data values
2339 2324
      *
2340 2325
      * @return float
2341 2326
      */
@@ -2379,7 +2364,6 @@  discard block
 block discarded – undo
2379 2364
      *
2380 2365
      * @category Statistical Functions
2381 2366
      *
2382
-     * @param mixed $arg,... Data values
2383 2367
      *
2384 2368
      * @return float
2385 2369
      */
@@ -2415,7 +2399,6 @@  discard block
 block discarded – undo
2415 2399
      *
2416 2400
      * @category Statistical Functions
2417 2401
      *
2418
-     * @param mixed $arg,... Data values
2419 2402
      *
2420 2403
      * @return float
2421 2404
      */
@@ -2456,7 +2439,6 @@  discard block
 block discarded – undo
2456 2439
      *
2457 2440
      * @category Mathematical and Trigonometric Functions
2458 2441
      *
2459
-     * @param mixed  $arg,...   Data values
2460 2442
      * @param string $condition The criteria that defines which cells will be checked
2461 2443
      *
2462 2444
      * @return float
@@ -2533,7 +2515,6 @@  discard block
 block discarded – undo
2533 2515
      *
2534 2516
      * @category Statistical Functions
2535 2517
      *
2536
-     * @param mixed $arg,... Data values
2537 2518
      *
2538 2519
      * @return float
2539 2520
      */
@@ -2707,8 +2688,6 @@  discard block
 block discarded – undo
2707 2688
      *
2708 2689
      * @category Statistical Functions
2709 2690
      *
2710
-     * @param mixed $arg,... Data values
2711
-     * @param float $entry   Percentile value in the range 0..1, inclusive
2712 2691
      *
2713 2692
      * @return float
2714 2693
      */
@@ -2877,8 +2856,6 @@  discard block
 block discarded – undo
2877 2856
      *
2878 2857
      * @category Statistical Functions
2879 2858
      *
2880
-     * @param mixed $arg,... Data values
2881
-     * @param int   $entry   Quartile value in the range 1..3, inclusive
2882 2859
      *
2883 2860
      * @return float
2884 2861
      */
@@ -3045,8 +3022,6 @@  discard block
 block discarded – undo
3045 3022
      *
3046 3023
      * @category Statistical Functions
3047 3024
      *
3048
-     * @param mixed $arg,... Data values
3049
-     * @param int   $entry   Position (ordered from the smallest) in the array or range of data to return
3050 3025
      *
3051 3026
      * @return float
3052 3027
      */
@@ -3117,7 +3092,6 @@  discard block
 block discarded – undo
3117 3092
      *
3118 3093
      * @category Statistical Functions
3119 3094
      *
3120
-     * @param mixed $arg,... Data values
3121 3095
      *
3122 3096
      * @return float
3123 3097
      */
@@ -3166,7 +3140,6 @@  discard block
 block discarded – undo
3166 3140
      *
3167 3141
      * @category Statistical Functions
3168 3142
      *
3169
-     * @param mixed $arg,... Data values
3170 3143
      *
3171 3144
      * @return float
3172 3145
      */
@@ -3218,7 +3191,6 @@  discard block
 block discarded – undo
3218 3191
      *
3219 3192
      * @category Statistical Functions
3220 3193
      *
3221
-     * @param mixed $arg,... Data values
3222 3194
      *
3223 3195
      * @return float
3224 3196
      */
@@ -3265,7 +3237,6 @@  discard block
 block discarded – undo
3265 3237
      *
3266 3238
      * @category Statistical Functions
3267 3239
      *
3268
-     * @param mixed $arg,... Data values
3269 3240
      *
3270 3241
      * @return float
3271 3242
      */
@@ -3503,8 +3474,6 @@  discard block
 block discarded – undo
3503 3474
      *
3504 3475
      * @category Statistical Functions
3505 3476
      *
3506
-     * @param mixed $arg,... Data values
3507
-     * @param float $discard Percentage to discard
3508 3477
      *
3509 3478
      * @return float
3510 3479
      */
@@ -3549,7 +3518,6 @@  discard block
 block discarded – undo
3549 3518
      *
3550 3519
      * @category Statistical Functions
3551 3520
      *
3552
-     * @param mixed $arg,... Data values
3553 3521
      *
3554 3522
      * @return float
3555 3523
      */
@@ -3593,7 +3561,6 @@  discard block
 block discarded – undo
3593 3561
      *
3594 3562
      * @category Statistical Functions
3595 3563
      *
3596
-     * @param mixed $arg,... Data values
3597 3564
      *
3598 3565
      * @return float
3599 3566
      */
@@ -3646,7 +3613,6 @@  discard block
 block discarded – undo
3646 3613
      *
3647 3614
      * @category Statistical Functions
3648 3615
      *
3649
-     * @param mixed $arg,... Data values
3650 3616
      *
3651 3617
      * @return float
3652 3618
      */
@@ -3691,7 +3657,6 @@  discard block
 block discarded – undo
3691 3657
      *
3692 3658
      * @category Statistical Functions
3693 3659
      *
3694
-     * @param mixed $arg,... Data values
3695 3660
      *
3696 3661
      * @return float
3697 3662
      */
Please login to merge, or discard this patch.