From 4e1566f3222badc32b91491675ade5a34f74904c Mon Sep 17 00:00:00 2001 From: Marcin Michalski Date: Wed, 21 Aug 2024 13:13:55 +0200 Subject: [PATCH] docs: use `return` tag to describe method return value (#763) --- lib/Date.php | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/Date.php b/lib/Date.php index 3fe30131..8fe86f7e 100644 --- a/lib/Date.php +++ b/lib/Date.php @@ -103,8 +103,8 @@ public function isBetween(self $start, self $end): bool } /** - * Returns an instance of {@see Date} incremented by the specified number of months. - * If the resulting month has fewer days than the current day, the day will be the last day of that month. + * @return self Instance incremented by the specified number of months. + * If the resulting month has fewer days than the current day, the day will be the last day of that month. * * @throws \InvalidArgumentException if $increment is less than 1 */ @@ -158,7 +158,7 @@ public function offsetByYears(int $years): self } /** - * Returns an instance of \DateTimeImmutable shifted to start of day in a given timezone (falls back to system default) + * @return \DateTimeImmutable Instance shifted to start of day in a given timezone (falls back to system default) */ public function startOfDay(\DateTimeZone $timezone = null): \DateTimeImmutable { @@ -166,7 +166,7 @@ public function startOfDay(\DateTimeZone $timezone = null): \DateTimeImmutable } /** - * Returns an instance of \DateTimeImmutable shifted to end of day in a given timezone (falls back to system default) + * @return \DateTimeImmutable Instance shifted to end of day in a given timezone (falls back to system default) */ public function endOfDay(\DateTimeZone $timezone = null): \DateTimeImmutable {