[CS] Remove @inheritdoc PHPDoc

lyrixx · lyrixx · commit 11c0c0842f98 · 2022-08-25T17:27:04.000+02:00
diff --git a/Debug/TraceableEventDispatcher.php b/Debug/TraceableEventDispatcher.php
@@ -51,25 +51,16 @@ public function __construct(EventDispatcherInterface $dispatcher, Stopwatch $sto
         $this->requestStack = $requestStack;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function addListener(string $eventName, callable|array $listener, int $priority = 0)
     {
         $this->dispatcher->addListener($eventName, $listener, $priority);
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function addSubscriber(EventSubscriberInterface $subscriber)
     {
         $this->dispatcher->addSubscriber($subscriber);
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function removeListener(string $eventName, callable|array $listener)
     {
         if (isset($this->wrappedListeners[$eventName])) {
@@ -85,25 +76,16 @@ public function removeListener(string $eventName, callable|array $listener)
         return $this->dispatcher->removeListener($eventName, $listener);
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function removeSubscriber(EventSubscriberInterface $subscriber)
     {
         return $this->dispatcher->removeSubscriber($subscriber);
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getListeners(string $eventName = null): array
     {
         return $this->dispatcher->getListeners($eventName);
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getListenerPriority(string $eventName, callable|array $listener): ?int
     {
         // we might have wrapped listeners for the event (if called while dispatching)
@@ -119,17 +101,11 @@ public function getListenerPriority(string $eventName, callable|array $listener)
         return $this->dispatcher->getListenerPriority($eventName, $listener);
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function hasListeners(string $eventName = null): bool
     {
         return $this->dispatcher->hasListeners($eventName);
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function dispatch(object $event, string $eventName = null): object
     {
         $eventName ??= \get_class($event);
diff --git a/EventDispatcher.php b/EventDispatcher.php
@@ -42,9 +42,6 @@ public function __construct()
         }
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function dispatch(object $event, string $eventName = null): object
     {
         $eventName ??= \get_class($event);
@@ -62,9 +59,6 @@ public function dispatch(object $event, string $eventName = null): object
         return $event;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getListeners(string $eventName = null): array
     {
         if (null !== $eventName) {
@@ -88,9 +82,6 @@ public function getListeners(string $eventName = null): array
         return array_filter($this->sorted);
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getListenerPriority(string $eventName, callable|array $listener): ?int
     {
         if (empty($this->listeners[$eventName])) {
@@ -117,9 +108,6 @@ public function getListenerPriority(string $eventName, callable|array $listener)
         return null;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function hasListeners(string $eventName = null): bool
     {
         if (null !== $eventName) {
@@ -135,18 +123,12 @@ public function hasListeners(string $eventName = null): bool
         return false;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function addListener(string $eventName, callable|array $listener, int $priority = 0)
     {
         $this->listeners[$eventName][$priority][] = $listener;
         unset($this->sorted[$eventName], $this->optimized[$eventName]);
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function removeListener(string $eventName, callable|array $listener)
     {
         if (empty($this->listeners[$eventName])) {
@@ -175,9 +157,6 @@ public function removeListener(string $eventName, callable|array $listener)
         }
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function addSubscriber(EventSubscriberInterface $subscriber)
     {
         foreach ($subscriber->getSubscribedEvents() as $eventName => $params) {
@@ -193,9 +172,6 @@ public function addSubscriber(EventSubscriberInterface $subscriber)
         }
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function removeSubscriber(EventSubscriberInterface $subscriber)
     {
         foreach ($subscriber->getSubscribedEvents() as $eventName => $params) {
diff --git a/ImmutableEventDispatcher.php b/ImmutableEventDispatcher.php
@@ -25,65 +25,41 @@ public function __construct(EventDispatcherInterface $dispatcher)
         $this->dispatcher = $dispatcher;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function dispatch(object $event, string $eventName = null): object
     {
         return $this->dispatcher->dispatch($event, $eventName);
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function addListener(string $eventName, callable|array $listener, int $priority = 0)
     {
         throw new \BadMethodCallException('Unmodifiable event dispatchers must not be modified.');
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function addSubscriber(EventSubscriberInterface $subscriber)
     {
         throw new \BadMethodCallException('Unmodifiable event dispatchers must not be modified.');
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function removeListener(string $eventName, callable|array $listener)
     {
         throw new \BadMethodCallException('Unmodifiable event dispatchers must not be modified.');
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function removeSubscriber(EventSubscriberInterface $subscriber)
     {
         throw new \BadMethodCallException('Unmodifiable event dispatchers must not be modified.');
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getListeners(string $eventName = null): array
     {
         return $this->dispatcher->getListeners($eventName);
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getListenerPriority(string $eventName, callable|array $listener): ?int
     {
         return $this->dispatcher->getListenerPriority($eventName, $listener);
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function hasListeners(string $eventName = null): bool
     {
         return $this->dispatcher->hasListeners($eventName);

Original file line number	Diff line number	Diff line change
`@@ -51,25 +51,16 @@ public function __construct(EventDispatcherInterface $dispatcher, Stopwatch $sto`
`51`	`51`	`$this->requestStack = $requestStack;`
`52`	`52`	`}`
`53`	`53`
`54`		`- /**`
`55`		`- * {@inheritdoc}`
`56`		`- */`
`57`	`54`	`public function addListener(string $eventName, callable\|array $listener, int $priority = 0)`
`58`	`55`	`{`
`59`	`56`	`$this->dispatcher->addListener($eventName, $listener, $priority);`
`60`	`57`	`}`
`61`	`58`
`62`		`- /**`
`63`		`- * {@inheritdoc}`
`64`		`- */`
`65`	`59`	`public function addSubscriber(EventSubscriberInterface $subscriber)`
`66`	`60`	`{`
`67`	`61`	`$this->dispatcher->addSubscriber($subscriber);`
`68`	`62`	`}`
`69`	`63`
`70`		`- /**`
`71`		`- * {@inheritdoc}`
`72`		`- */`
`73`	`64`	`public function removeListener(string $eventName, callable\|array $listener)`
`74`	`65`	`{`
`75`	`66`	`if (isset($this->wrappedListeners[$eventName])) {`
`@@ -85,25 +76,16 @@ public function removeListener(string $eventName, callable\|array $listener)`
`85`	`76`	`return $this->dispatcher->removeListener($eventName, $listener);`
`86`	`77`	`}`
`87`	`78`
`88`		`- /**`
`89`		`- * {@inheritdoc}`
`90`		`- */`
`91`	`79`	`public function removeSubscriber(EventSubscriberInterface $subscriber)`
`92`	`80`	`{`
`93`	`81`	`return $this->dispatcher->removeSubscriber($subscriber);`
`94`	`82`	`}`
`95`	`83`
`96`		`- /**`
`97`		`- * {@inheritdoc}`
`98`		`- */`
`99`	`84`	`public function getListeners(string $eventName = null): array`
`100`	`85`	`{`
`101`	`86`	`return $this->dispatcher->getListeners($eventName);`
`102`	`87`	`}`
`103`	`88`
`104`		`- /**`
`105`		`- * {@inheritdoc}`
`106`		`- */`
`107`	`89`	`public function getListenerPriority(string $eventName, callable\|array $listener): ?int`
`108`	`90`	`{`
`109`	`91`	`// we might have wrapped listeners for the event (if called while dispatching)`
`@@ -119,17 +101,11 @@ public function getListenerPriority(string $eventName, callable\|array $listener)`
`119`	`101`	`return $this->dispatcher->getListenerPriority($eventName, $listener);`
`120`	`102`	`}`
`121`	`103`
`122`		`- /**`
`123`		`- * {@inheritdoc}`
`124`		`- */`
`125`	`104`	`public function hasListeners(string $eventName = null): bool`
`126`	`105`	`{`
`127`	`106`	`return $this->dispatcher->hasListeners($eventName);`
`128`	`107`	`}`
`129`	`108`
`130`		`- /**`
`131`		`- * {@inheritdoc}`
`132`		`- */`
`133`	`109`	`public function dispatch(object $event, string $eventName = null): object`
`134`	`110`	`{`
`135`	`111`	`$eventName ??= \get_class($event);`
Original file line number	Diff line number	Diff line change
`@@ -42,9 +42,6 @@ public function __construct()`
`42`	`42`	`}`
`43`	`43`	`}`
`44`	`44`
`45`		`- /**`
`46`		`- * {@inheritdoc}`
`47`		`- */`
`48`	`45`	`public function dispatch(object $event, string $eventName = null): object`
`49`	`46`	`{`
`50`	`47`	`$eventName ??= \get_class($event);`
`@@ -62,9 +59,6 @@ public function dispatch(object $event, string $eventName = null): object`
`62`	`59`	`return $event;`
`63`	`60`	`}`
`64`	`61`
`65`		`- /**`
`66`		`- * {@inheritdoc}`
`67`		`- */`
`68`	`62`	`public function getListeners(string $eventName = null): array`
`69`	`63`	`{`
`70`	`64`	`if (null !== $eventName) {`
`@@ -88,9 +82,6 @@ public function getListeners(string $eventName = null): array`
`88`	`82`	`return array_filter($this->sorted);`
`89`	`83`	`}`
`90`	`84`
`91`		`- /**`
`92`		`- * {@inheritdoc}`
`93`		`- */`
`94`	`85`	`public function getListenerPriority(string $eventName, callable\|array $listener): ?int`
`95`	`86`	`{`
`96`	`87`	`if (empty($this->listeners[$eventName])) {`
`@@ -117,9 +108,6 @@ public function getListenerPriority(string $eventName, callable\|array $listener)`
`117`	`108`	`return null;`
`118`	`109`	`}`
`119`	`110`
`120`		`- /**`
`121`		`- * {@inheritdoc}`
`122`		`- */`
`123`	`111`	`public function hasListeners(string $eventName = null): bool`
`124`	`112`	`{`
`125`	`113`	`if (null !== $eventName) {`
`@@ -135,18 +123,12 @@ public function hasListeners(string $eventName = null): bool`
`135`	`123`	`return false;`
`136`	`124`	`}`
`137`	`125`
`138`		`- /**`
`139`		`- * {@inheritdoc}`
`140`		`- */`
`141`	`126`	`public function addListener(string $eventName, callable\|array $listener, int $priority = 0)`
`142`	`127`	`{`
`143`	`128`	`$this->listeners[$eventName][$priority][] = $listener;`
`144`	`129`	`unset($this->sorted[$eventName], $this->optimized[$eventName]);`
`145`	`130`	`}`
`146`	`131`
`147`		`- /**`
`148`		`- * {@inheritdoc}`
`149`		`- */`
`150`	`132`	`public function removeListener(string $eventName, callable\|array $listener)`
`151`	`133`	`{`
`152`	`134`	`if (empty($this->listeners[$eventName])) {`
`@@ -175,9 +157,6 @@ public function removeListener(string $eventName, callable\|array $listener)`
`175`	`157`	`}`
`176`	`158`	`}`
`177`	`159`
`178`		`- /**`
`179`		`- * {@inheritdoc}`
`180`		`- */`
`181`	`160`	`public function addSubscriber(EventSubscriberInterface $subscriber)`
`182`	`161`	`{`
`183`	`162`	`foreach ($subscriber->getSubscribedEvents() as $eventName => $params) {`
`@@ -193,9 +172,6 @@ public function addSubscriber(EventSubscriberInterface $subscriber)`
`193`	`172`	`}`
`194`	`173`	`}`
`195`	`174`
`196`		`- /**`
`197`		`- * {@inheritdoc}`
`198`		`- */`
`199`	`175`	`public function removeSubscriber(EventSubscriberInterface $subscriber)`
`200`	`176`	`{`
`201`	`177`	`foreach ($subscriber->getSubscribedEvents() as $eventName => $params) {`
Original file line number	Diff line number	Diff line change
`@@ -25,65 +25,41 @@ public function __construct(EventDispatcherInterface $dispatcher)`
`25`	`25`	`$this->dispatcher = $dispatcher;`
`26`	`26`	`}`
`27`	`27`
`28`		`- /**`
`29`		`- * {@inheritdoc}`
`30`		`- */`
`31`	`28`	`public function dispatch(object $event, string $eventName = null): object`
`32`	`29`	`{`
`33`	`30`	`return $this->dispatcher->dispatch($event, $eventName);`
`34`	`31`	`}`
`35`	`32`
`36`		`- /**`
`37`		`- * {@inheritdoc}`
`38`		`- */`
`39`	`33`	`public function addListener(string $eventName, callable\|array $listener, int $priority = 0)`
`40`	`34`	`{`
`41`	`35`	`throw new \BadMethodCallException('Unmodifiable event dispatchers must not be modified.');`
`42`	`36`	`}`
`43`	`37`
`44`		`- /**`
`45`		`- * {@inheritdoc}`
`46`		`- */`
`47`	`38`	`public function addSubscriber(EventSubscriberInterface $subscriber)`
`48`	`39`	`{`
`49`	`40`	`throw new \BadMethodCallException('Unmodifiable event dispatchers must not be modified.');`
`50`	`41`	`}`
`51`	`42`
`52`		`- /**`
`53`		`- * {@inheritdoc}`
`54`		`- */`
`55`	`43`	`public function removeListener(string $eventName, callable\|array $listener)`
`56`	`44`	`{`
`57`	`45`	`throw new \BadMethodCallException('Unmodifiable event dispatchers must not be modified.');`
`58`	`46`	`}`
`59`	`47`
`60`		`- /**`
`61`		`- * {@inheritdoc}`
`62`		`- */`
`63`	`48`	`public function removeSubscriber(EventSubscriberInterface $subscriber)`
`64`	`49`	`{`
`65`	`50`	`throw new \BadMethodCallException('Unmodifiable event dispatchers must not be modified.');`
`66`	`51`	`}`
`67`	`52`
`68`		`- /**`
`69`		`- * {@inheritdoc}`
`70`		`- */`
`71`	`53`	`public function getListeners(string $eventName = null): array`
`72`	`54`	`{`
`73`	`55`	`return $this->dispatcher->getListeners($eventName);`
`74`	`56`	`}`
`75`	`57`
`76`		`- /**`
`77`		`- * {@inheritdoc}`
`78`		`- */`
`79`	`58`	`public function getListenerPriority(string $eventName, callable\|array $listener): ?int`
`80`	`59`	`{`
`81`	`60`	`return $this->dispatcher->getListenerPriority($eventName, $listener);`
`82`	`61`	`}`
`83`	`62`
`84`		`- /**`
`85`		`- * {@inheritdoc}`
`86`		`- */`
`87`	`63`	`public function hasListeners(string $eventName = null): bool`
`88`	`64`	`{`
`89`	`65`	`return $this->dispatcher->hasListeners($eventName);`