minor #29681 [Stopwatch] Fixed phpdoc for category name (samnela)

fabpot · fabpot · commit 3be044559671 · 2018-12-26T11:41:44.000+01:00
This PR was merged into the 3.4 branch. Discussion ---------- [Stopwatch] Fixed phpdoc for category name | Q | A | ------------- | --- | Branch? | 3.4  | Bug fix? | yes | New feature? | no  | BC breaks? | no  | Deprecations? | no  | Tests pass? | yes  | Fixed tickets | n/a  | License | MIT | Doc PR | n/a   Commits ------- 7f46dfb [Stopwatch] Fixed phpdoc for category name
diff --git a/src/Symfony/Component/Stopwatch/Stopwatch.php b/src/Symfony/Component/Stopwatch/Stopwatch.php
@@ -96,8 +96,8 @@ public function stopSection($id)
     /**
      * Starts an event.
      *
-     * @param string $name     The event name
-     * @param string $category The event category
+     * @param string      $name     The event name
+     * @param string|null $category The event category
      *
      * @return StopwatchEvent
      */
diff --git a/src/Symfony/Component/Stopwatch/Tests/StopwatchTest.php b/src/Symfony/Component/Stopwatch/Tests/StopwatchTest.php
@@ -35,6 +35,14 @@ public function testStart()
         $this->assertSame($event, $stopwatch->getEvent('foo'));
     }
 
+    public function testStartWithoutCategory()
+    {
+        $stopwatch = new Stopwatch();
+        $stopwatchEvent = $stopwatch->start('bar');
+        $this->assertSame('default', $stopwatchEvent->getCategory());
+        $this->assertSame($stopwatchEvent, $stopwatch->getEvent('bar'));
+    }
+
     public function testIsStarted()
     {
         $stopwatch = new Stopwatch();

Original file line number	Diff line number	Diff line change
`@@ -96,8 +96,8 @@ public function stopSection($id)`
`96`	`96`	`/**`
`97`	`97`	`* Starts an event.`
`98`	`98`	`*`
`99`		`- * @param string $name The event name`
`100`		`- * @param string $category The event category`
	`99`	`+ * @param string $name The event name`
	`100`	`+ * @param string\|null $category The event category`
`101`	`101`	`*`
`102`	`102`	`* @return StopwatchEvent`
`103`	`103`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -35,6 +35,14 @@ public function testStart()`
`35`	`35`	`$this->assertSame($event, $stopwatch->getEvent('foo'));`
`36`	`36`	`}`
`37`	`37`
	`38`	`+ public function testStartWithoutCategory()`
	`39`	`+ {`
	`40`	`+ $stopwatch = new Stopwatch();`
	`41`	`+ $stopwatchEvent = $stopwatch->start('bar');`
	`42`	`+ $this->assertSame('default', $stopwatchEvent->getCategory());`
	`43`	`+ $this->assertSame($stopwatchEvent, $stopwatch->getEvent('bar'));`
	`44`	`+ }`
	`45`	`+`
`38`	`46`	`public function testIsStarted()`
`39`	`47`	`{`
`40`	`48`	`$stopwatch = new Stopwatch();`