Skip to content

Commit 2e4f20b

Browse files
committed
PHPDoc comment update for Timer::read()
1 parent 278a3bc commit 2e4f20b

File tree

1 file changed

+5
-8
lines changed

1 file changed

+5
-8
lines changed

src/Timer.php

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -80,16 +80,13 @@ public static function resetAll(): void {
8080
*
8181
* @param string $key The key that the timer was started with. Default value is
8282
* "default" throughout the class.
83-
* @param string $format
83+
* @param string $format The default format is milliseconds. See the class constants for additional
84+
* formats.
8485
*
85-
* @return mixed The formatted time.
86+
* @return mixed The formatted time, formatted by the formatter string passed for $format.
8687
* @throws \LogicException
87-
* @see \Ayesh\PHP_Timer\Timer::start() was called with. If the timer was not
88-
* started, a \LogicException will be thrown.
89-
*
90-
* The default format is milliseconds. See the class constants for additional
91-
* formats.
92-
*
88+
* If the timer was not started, a \LogicException will be thrown. Use @see \Ayesh\PHP_Timer\Timer::start()
89+
* to start a timer.
9390
*/
9491
public static function read(string $key = 'default', $format = self::FORMAT_MILLISECONDS) {
9592
if (isset(self::$timers[$key])) {

0 commit comments

Comments
 (0)