Merge pull request #1785 from cultuurnet/III-6308-remove-unneeded-inh…

…eritdoc-comments III-6308 Remove unneeded inheritdoc comments
cultuurnet · Sep 12, 2024 · 5b0e020 · 5b0e020
2 parents 1380d2c + 1faafbf
commit 5b0e020
Show file tree

Hide file tree

Showing 26 changed files with 3 additions and 90 deletions.
diff --git a/app/Migrations/Version20150817113039.php b/app/Migrations/Version20150817113039.php
@@ -9,9 +9,6 @@
 
 class Version20150817113039 extends AbstractMigration
 {
-    /**
-     * @inheritdoc
-     */
     public function up(Schema $schema): void
     {
         $table = $schema->createTable('index_readmodel');
@@ -48,9 +45,6 @@ public function up(Schema $schema): void
         $table->setPrimaryKey(['entity_id', 'entity_type']);
     }
 
-    /**
-     * @inheritdoc
-     */
     public function down(Schema $schema): void
     {
         $schema->dropTable('index_readmodel');

diff --git a/src/CommandHandling/Udb3CommandHandler.php b/src/CommandHandling/Udb3CommandHandler.php
@@ -11,9 +11,6 @@
  */
 abstract class Udb3CommandHandler implements CommandHandler
 {
-    /**
-     * {@inheritDoc}
-     */
     public function handle($command): void
     {
         $method = $this->getHandleMethod($command);

diff --git a/src/Event/EventFacilityResolver.php b/src/Event/EventFacilityResolver.php
@@ -9,9 +9,6 @@
 
 class EventFacilityResolver extends OfferFacilityResolver
 {
-    /**
-     * @inheritdoc
-     */
     final protected function getFacilities(): array
     {
         return [

diff --git a/src/History/Log.php b/src/History/Log.php
@@ -77,9 +77,6 @@ public function withDate(DateTime $dateTime): Log
         return $log;
     }
 
-    /**
-     * @inheritdoc
-     */
     public function jsonSerialize(): array
     {
         $log = [

diff --git a/src/Http/Deserializer/Event/CreateEventDataValidator.php b/src/Http/Deserializer/Event/CreateEventDataValidator.php
@@ -23,9 +23,6 @@ public function __construct()
             ->withValidator(new RequiredPropertiesDataValidator(['mainLanguage']));
     }
 
-    /**
-     * @inheritdoc
-     */
     public function validate(array $data): void
     {
         $this->validator->validate($data);

diff --git a/src/Http/Deserializer/Place/CreatePlaceDataValidator.php b/src/Http/Deserializer/Place/CreatePlaceDataValidator.php
@@ -23,9 +23,6 @@ public function __construct()
             ->withValidator(new RequiredPropertiesDataValidator(['mainLanguage']));
     }
 
-    /**
-     * @inheritdoc
-     */
     public function validate(array $data): void
     {
         $this->validator->validate($data);

diff --git a/src/Http/Response/JsonLdResponse.php b/src/Http/Response/JsonLdResponse.php
@@ -9,9 +9,6 @@
 
 class JsonLdResponse extends JsonResponse
 {
-    /**
-     * @inheritdoc
-     */
     public function __construct($data = null, $status = 200, ?HeadersInterface $headers = null)
     {
         if (!($headers instanceof HeadersInterface)) {

diff --git a/src/Label/ReadModels/JSON/Repository/Entity.php b/src/Label/ReadModels/JSON/Repository/Entity.php
@@ -65,9 +65,6 @@ public function isExcluded(): bool
         return $this->excluded;
     }
 
-    /**
-     * @inheritdoc
-     */
     public function jsonSerialize(): array
     {
         return [

diff --git a/src/Log/ContextEnrichingLogger.php b/src/Log/ContextEnrichingLogger.php
@@ -25,9 +25,6 @@ public function __construct(LoggerInterface $decoratee, array $context)
         $this->context = $context;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function log($level, $message, array $context = []): void
     {
         $enrichedContext = $this->context + $context;

diff --git a/src/Log/SocketIOEmitterHandler.php b/src/Log/SocketIOEmitterHandler.php
@@ -4,6 +4,7 @@
 
 namespace CultuurNet\UDB3\Log;
 
+use Monolog\Formatter\FormatterInterface;
 use Monolog\Formatter\NormalizerFormatter;
 use Monolog\Handler\AbstractProcessingHandler;
 use Monolog\Logger;
@@ -27,21 +28,15 @@ public function __construct(Emitter $emitter, $level = Logger::DEBUG, $bubble =
         $this->emitter = $emitter;
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    protected function write(array $record)
+    protected function write(array $record): void
     {
         $event = $record['formatted']['message'];
         $data = $record['formatted']['context'];
 
         $this->emitter->emit($event, $data);
     }
 
-    /**
-     * @inheritdoc
-     */
-    protected function getDefaultFormatter()
+    protected function getDefaultFormatter(): FormatterInterface
     {
         return new NormalizerFormatter();
     }

diff --git a/src/Model/Event/ImmutableEvent.php b/src/Model/Event/ImmutableEvent.php
@@ -97,9 +97,6 @@ public function withAudienceType(AudienceType $audience): ImmutableEvent
         return $c;
     }
 
-    /**
-     * @inheritdoc
-     */
     protected function guardCalendarType(Calendar $calendar): void
     {
         // Any calendar is fine for events.

diff --git a/src/Model/Place/ImmutablePlace.php b/src/Model/Place/ImmutablePlace.php
@@ -138,9 +138,6 @@ public static function getNilLocationId(): UUID
         return new UUID('00000000-0000-0000-0000-000000000000');
     }
 
-    /**
-     * @inheritdoc
-     */
     protected function guardCalendarType(Calendar $calendar): void
     {
         if (!($calendar instanceof CalendarWithOpeningHours)) {

diff --git a/src/Model/Serializer/ValueObject/Audience/AgeRangeDenormalizer.php b/src/Model/Serializer/ValueObject/Audience/AgeRangeDenormalizer.php
@@ -50,9 +50,6 @@ private function getParts(string $data, string $class, ?string $format): array
         ];
     }
 
-    /**
-     * @inheritdoc
-     */
     public function supportsDenormalization($data, $type, $format = null): bool
     {
         return $type === AgeRange::class;

diff --git a/src/Model/ValueObject/Calendar/CalendarType.php b/src/Model/ValueObject/Calendar/CalendarType.php
@@ -14,9 +14,6 @@
  */
 class CalendarType extends Enum
 {
-    /**
-     * @inheritdoc
-     */
     public static function getAllowedValues(): array
     {
         return [

diff --git a/src/Model/ValueObject/Calendar/OpeningHours/Day.php b/src/Model/ValueObject/Calendar/OpeningHours/Day.php
@@ -17,9 +17,6 @@
  */
 class Day extends Enum
 {
-    /**
-     * @inheritdoc
-     */
     public static function getAllowedValues(): array
     {
         return [

diff --git a/src/Model/ValueObject/Calendar/StatusType.php b/src/Model/ValueObject/Calendar/StatusType.php
@@ -13,9 +13,6 @@
  */
 class StatusType extends Enum
 {
-    /**
-     * @inheritdoc
-     */
     public static function getAllowedValues(): array
     {
         return [

diff --git a/src/Offer/OfferCommandHandler.php b/src/Offer/OfferCommandHandler.php
@@ -43,9 +43,6 @@ public function __construct(
         $this->mediaManager = $mediaManager;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function handle($command): void
     {
         $commandName = get_class($command);

diff --git a/src/Offer/ReadModel/JSONLD/CdbXmlContactInfoImporter.php b/src/Offer/ReadModel/JSONLD/CdbXmlContactInfoImporter.php
@@ -10,9 +10,6 @@ class CdbXmlContactInfoImporter implements CdbXmlContactInfoImporterInterface
 {
     use MultilingualJsonLDProjectorTrait;
 
-    /**
-     * @inheritdoc
-     */
     public function importBookingInfo(
         \stdClass $jsonLD,
         \CultureFeed_Cdb_Data_ContactInfo $contactInfo,
@@ -77,9 +74,6 @@ public function importBookingInfo(
         }
     }
 
-    /**
-     * @inheritdoc
-     */
     public function importContactPoint(
         \stdClass $jsonLD,
         \CultureFeed_Cdb_Data_ContactInfo $contactInfo

diff --git a/src/Role/Events/AbstractEvent.php b/src/Role/Events/AbstractEvent.php
@@ -23,9 +23,6 @@ public function getUuid(): UUID
         return $this->uuid;
     }
 
-    /**
-     * @inheritdoc
-     */
     public function serialize(): array
     {
         return ['uuid' => $this->getUuid()->toString()];

diff --git a/src/SavedSearches/UDB3SavedSearchRepository.php b/src/SavedSearches/UDB3SavedSearchRepository.php
@@ -99,9 +99,6 @@ public function delete(
         $queryBuilder->execute();
     }
 
-    /**
-     * @inheritdoc
-     */
     public function ownedByCurrentUser(): array
     {
         $queryBuilder = $this->connection->createQueryBuilder()

diff --git a/tests/EventExport/Format/HTML/HTMLFileWriterTest.php b/tests/EventExport/Format/HTML/HTMLFileWriterTest.php
@@ -511,9 +511,6 @@ protected function assertHTMLFileContents(string $html, string $filePath): void
         $this->assertEquals($html, SampleFiles::read($filePath));
     }
 
-    /**
-     * @inheritdoc
-     */
     public function tearDown(): void
     {
         if ($this->filePath && file_exists($this->filePath)) {

diff --git a/tests/Label/CommandHandlerTest.php b/tests/Label/CommandHandlerTest.php
@@ -57,9 +57,6 @@ public function setUp(): void
         parent::setUp();
     }
 
-    /**
-     * @inheritdoc
-     */
     protected function createCommandHandler(
         EventStore $eventStore,
         EventBus $eventBus

diff --git a/tests/Model/Offer/MockImmutableOffer.php b/tests/Model/Offer/MockImmutableOffer.php
@@ -8,11 +8,7 @@
 
 class MockImmutableOffer extends ImmutableOffer
 {
-    /**
-     * @inheritdoc
-     */
     protected function guardCalendarType(Calendar $calendar): void
     {
-        return;
     }
 }
diff --git a/tests/StringFilter/StringFilterTest.php b/tests/StringFilter/StringFilterTest.php
@@ -20,9 +20,6 @@ abstract class StringFilterTest extends TestCase
 
     protected StringFilterInterface $filter;
 
-    /**
-     * {@inheritdoc}
-     */
     public function setUp(): void
     {
         parent::setUp();

diff --git a/tests/StringFilter/StripSourceStringFilterTest.php b/tests/StringFilter/StripSourceStringFilterTest.php
@@ -6,9 +6,6 @@
 
 class StripSourceStringFilterTest extends StringFilterTest
 {
-    /**
-     * {@inheritdoc}
-     */
     protected string $filterClass = StripSourceStringFilter::class;
 
     /**

diff --git a/tests/StringFilter/TidyStringFilterTest.php b/tests/StringFilter/TidyStringFilterTest.php
@@ -6,9 +6,6 @@
 
 class TidyStringFilterTest extends StringFilterTest
 {
-    /**
-     * {@inheritdoc}
-     */
     protected string $filterClass = TidyStringFilter::class;
 
     /**