PHPOffice / PhpSpreadsheet

src/PhpSpreadsheet/Calculation/MathTrig.php

Doc Comments +18 added lines, -11 removed lines

@@ -10,6 +10,10 @@ 
     //
     //    Private method to return an array of the factors of the input value
     //
+
+    /**
+     * @param double $value
+     */
     private static function factors($value)
     {
         $startVal = floor(sqrt($value));
@@ -33,6 +37,10 @@ 
         return [(int) $value];
     }
 
+    /**
+     * @param integer $num
+     * @param integer $n
+     */
     private static function romanCut($num, $n)
     {
         return ($num - ($num % $n)) / $n;
@@ -312,6 +320,9 @@ 
         return Functions::VALUE();
     }
 
+    /**
+     * @param integer $b
+     */
     public static function evaluateGCD($a, $b) {
         // As we're just working with two values, we can use the recursive Euclidian method
         // If we were working with more than two values, we need to extend as
@@ -454,7 +465,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
      */
@@ -772,8 +783,8 @@ 
      *
      * Computes x raised to the power y.
      *
-     * @param float $x
-     * @param float $y
+     * @param integer $x
+     * @param integer $y
      *
      * @return float
      */
@@ -847,7 +858,7 @@ 
      *
      * @param mixed ...$args Data values
      *
-     * @return float
+     * @return integer
      */
     public static function QUOTIENT(...$args)
     {
@@ -985,9 +996,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
@@ -1184,7 +1192,7 @@ 
      * @param mixed $aArgs
      * @param mixed $sumArgs
      *
-     * @return float
+     * @return integer
      */
     public static function SUMIF($aArgs, $condition, $sumArgs = [])
     {
@@ -1224,9 +1232,8 @@ 
      *    @category Mathematical and Trigonometric Functions
      *
      * @param mixed $args Data values
-     * @param string $condition the criteria that defines which cells will be summed
      *
-     * @return float
+     * @return integer
      */
     public static function SUMIFS(...$args)
     {
@@ -1415,7 +1422,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