Fix PHPDocs Shared/Trend/BestFit

Dfred · Oct 29, 2018 · 0e39ffe · 0e39ffe
1 parent 3162ad2
commit 0e39ffe
Showing 1 changed file with 44 additions and 4 deletions.
diff --git a/src/PhpSpreadsheet/Shared/Trend/BestFit.php b/src/PhpSpreadsheet/Shared/Trend/BestFit.php
@@ -142,7 +142,7 @@ public function getEquation($dp = 0)
      *
      * @param int $dp Number of places of decimal precision to display
      *
-     * @return string
+     * @return float
      */
     public function getSlope($dp = 0)
     {
@@ -158,7 +158,7 @@ public function getSlope($dp = 0)
      *
      * @param int $dp Number of places of decimal precision to display
      *
-     * @return string
+     * @return float
      */
     public function getSlopeSE($dp = 0)
     {
@@ -174,7 +174,7 @@ public function getSlopeSE($dp = 0)
      *
      * @param int $dp Number of places of decimal precision to display
      *
-     * @return string
+     * @return float
      */
     public function getIntersect($dp = 0)
     {
@@ -190,7 +190,7 @@ public function getIntersect($dp = 0)
      *
      * @param int $dp Number of places of decimal precision to display
      *
-     * @return string
+     * @return float
      */
     public function getIntersectSE($dp = 0)
     {
@@ -217,6 +217,13 @@ public function getGoodnessOfFit($dp = 0)
         return $this->goodnessOfFit;
     }
 
+    /**
+     * Return the goodness of fit for this regression.
+     *
+     * @param int $dp Number of places of decimal precision to return
+     *
+     * @return float
+     */
     public function getGoodnessOfFitPercent($dp = 0)
     {
         if ($dp != 0) {
@@ -242,6 +249,11 @@ public function getStdevOfResiduals($dp = 0)
         return $this->stdevOfResiduals;
     }
 
+    /**
+     * @param int $dp Number of places of decimal precision to return
+     *
+     * @return float
+     */
     public function getSSRegression($dp = 0)
     {
         if ($dp != 0) {
@@ -251,6 +263,11 @@ public function getSSRegression($dp = 0)
         return $this->SSRegression;
     }
 
+    /**
+     * @param int $dp Number of places of decimal precision to return
+     *
+     * @return float
+     */
     public function getSSResiduals($dp = 0)
     {
         if ($dp != 0) {
@@ -260,6 +277,11 @@ public function getSSResiduals($dp = 0)
         return $this->SSResiduals;
     }
 
+    /**
+     * @param int $dp Number of places of decimal precision to return
+     *
+     * @return float
+     */
     public function getDFResiduals($dp = 0)
     {
         if ($dp != 0) {
@@ -269,6 +291,11 @@ public function getDFResiduals($dp = 0)
         return $this->DFResiduals;
     }
 
+    /**
+     * @param int $dp Number of places of decimal precision to return
+     *
+     * @return float
+     */
     public function getF($dp = 0)
     {
         if ($dp != 0) {
@@ -278,6 +305,11 @@ public function getF($dp = 0)
         return $this->f;
     }
 
+    /**
+     * @param int $dp Number of places of decimal precision to return
+     *
+     * @return float
+     */
     public function getCovariance($dp = 0)
     {
         if ($dp != 0) {
@@ -287,6 +319,11 @@ public function getCovariance($dp = 0)
         return $this->covariance;
     }
 
+    /**
+     * @param int $dp Number of places of decimal precision to return
+     *
+     * @return float
+     */
     public function getCorrelation($dp = 0)
     {
         if ($dp != 0) {
@@ -296,6 +333,9 @@ public function getCorrelation($dp = 0)
         return $this->correlation;
     }
 
+    /**
+     * @return float[]
+     */
     public function getYBestFitValues()
     {
         return $this->yBestFitValues;