thephpleague / period

src/Period.php

Doc Comments +9 added lines, -9 removed lines

@@ -406,7 +406,7 @@ 
     /**
      * Returns the Period duration as expressed in seconds
      *
-     * @return float
+     * @return integer
      */
     public function getTimestampInterval()
     {
@@ -523,7 +523,7 @@ 
      * Tells whether the specified index is fully contained within
      * the current Period object.
      *
-     * @param Period|DateTimeInterface|string $index
+     * @param DateTimeImmutable $index
      *
      * @return bool
      */
@@ -631,7 +631,7 @@ 
     /**
      * Returns a new Period object with a new included starting date point.
      *
-     * @param DateTimeInterface|string $startDate date point
+     * @param DateTimeImmutable $startDate date point
      *
      * @return static
      */
@@ -643,7 +643,7 @@ 
     /**
      * Returns a new Period object with a new ending date point.
      *
-     * @param DateTimeInterface|string $endDate date point
+     * @param DateTimeImmutable $endDate date point
      *
      * @return static
      */
@@ -662,7 +662,7 @@ 
      * <li>a string in a format supported by DateInterval::createFromDateString</li>
      * </ul>
      *
-     * @param DateInterval|int|string $interval The interval
+     * @param DateInterval $interval The interval
      *
      * @return static
      */
@@ -889,7 +889,7 @@ 
      * @param DateInterval|int|string $interval The interval
      * @param bool                    $backwards Optionnal - iterates counterwise
      *
-     * @return Generator|Period[]
+     * @return Generator
      */
     public function split($interval, $backwards = false)
     {
@@ -962,7 +962,7 @@ 
      *
      * @param Period $period
      *
-     * @return float
+     * @return integer
      */
     public function timestampIntervalDiff(Period $period)
     {
@@ -1023,8 +1023,8 @@ 
      * The datepoints will be used as to allow the creation of
      * a Period object
      *
-     * @param DateTimeInterface|string $datePoint1 datepoint
-     * @param DateTimeInterface|string $datePoint2 datepoint
+     * @param DateTimeImmutable $datePoint1 datepoint
+     * @param DateTimeImmutable $datePoint2 datepoint
      *
      * @return Period
      */