minor #29743 [EventDispatcher] Fixed phpdoc on interface (samnela)

fabpot · fabpot · commit 99c92210c934 · 2019-01-01T19:08:36.000+01:00
This PR was merged into the 3.4 branch. Discussion ---------- [EventDispatcher] Fixed phpdoc on interface | 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 ------- 94bd28e [EventDispatcher] Fixed phpdoc on interface
diff --git a/src/Symfony/Component/EventDispatcher/EventDispatcherInterface.php b/src/Symfony/Component/EventDispatcher/EventDispatcherInterface.php
@@ -23,11 +23,11 @@ interface EventDispatcherInterface
     /**
      * Dispatches an event to all registered listeners.
      *
-     * @param string $eventName The name of the event to dispatch. The name of
-     *                          the event is the name of the method that is
-     *                          invoked on listeners.
-     * @param Event  $event     The event to pass to the event handlers/listeners
-     *                          If not supplied, an empty Event instance is created
+     * @param string     $eventName The name of the event to dispatch. The name of
+     *                              the event is the name of the method that is
+     *                              invoked on listeners.
+     * @param Event|null $event     The event to pass to the event handlers/listeners
+     *                              If not supplied, an empty Event instance is created
      *
      * @return Event
      */
@@ -64,7 +64,7 @@ public function removeSubscriber(EventSubscriberInterface $subscriber);
     /**
      * Gets the listeners of a specific event or all listeners sorted by descending priority.
      *
-     * @param string $eventName The name of the event
+     * @param string|null $eventName The name of the event
      *
      * @return array The event listeners for the specified event, or all event listeners by event name
      */
@@ -85,7 +85,7 @@ public function getListenerPriority($eventName, $listener);
     /**
      * Checks whether an event has any registered listeners.
      *
-     * @param string $eventName The name of the event
+     * @param string|null $eventName The name of the event
      *
      * @return bool true if the specified event has any listeners, false otherwise
      */

Original file line number	Diff line number	Diff line change
`@@ -23,11 +23,11 @@ interface EventDispatcherInterface`
`23`	`23`	`/**`
`24`	`24`	`* Dispatches an event to all registered listeners.`
`25`	`25`	`*`
`26`		`- * @param string $eventName The name of the event to dispatch. The name of`
`27`		`- * the event is the name of the method that is`
`28`		`- * invoked on listeners.`
`29`		`- * @param Event $event The event to pass to the event handlers/listeners`
`30`		`- * If not supplied, an empty Event instance is created`
	`26`	`+ * @param string $eventName The name of the event to dispatch. The name of`
	`27`	`+ * the event is the name of the method that is`
	`28`	`+ * invoked on listeners.`
	`29`	`+ * @param Event\|null $event The event to pass to the event handlers/listeners`
	`30`	`+ * If not supplied, an empty Event instance is created`
`31`	`31`	`*`
`32`	`32`	`* @return Event`
`33`	`33`	`*/`
`@@ -64,7 +64,7 @@ public function removeSubscriber(EventSubscriberInterface $subscriber);`
`64`	`64`	`/**`
`65`	`65`	`* Gets the listeners of a specific event or all listeners sorted by descending priority.`
`66`	`66`	`*`
`67`		`- * @param string $eventName The name of the event`
	`67`	`+ * @param string\|null $eventName The name of the event`
`68`	`68`	`*`
`69`	`69`	`* @return array The event listeners for the specified event, or all event listeners by event name`
`70`	`70`	`*/`
`@@ -85,7 +85,7 @@ public function getListenerPriority($eventName, $listener);`
`85`	`85`	`/**`
`86`	`86`	`* Checks whether an event has any registered listeners.`
`87`	`87`	`*`
`88`		`- * @param string $eventName The name of the event`
	`88`	`+ * @param string\|null $eventName The name of the event`
`89`	`89`	`*`
`90`	`90`	`* @return bool true if the specified event has any listeners, false otherwise`
`91`	`91`	`*/`