Cleaned up docblocks

symfony · andythorne · Jul 21, 2023 · Jul 21, 2023 · Jul 21, 2023 · Jul 21, 2023
commit 9622b677f814afb2178255f6a51a7ab7092d95b9
diff --git a/src/Symfony/Component/Messenger/Bridge/Kafka/Transport/Connection.php b/src/Symfony/Component/Messenger/Bridge/Kafka/Transport/Connection.php
@@ -58,8 +58,8 @@ class Connection
     private KafkaFactory $kafkaFactory;
 
     /**
-     * @psalm-param array{topics: list<string>, consume_timeout_ms: int, commit_async: bool, conf_options: array<string, string>} $consumerConfig
-     * @psalm-param array{topic: string, poll_timeout_ms: int, flush_timeout_ms: int, conf_options: array<string, string>} $producerConfig
+     * @param array{topics: list<string>, consume_timeout_ms: int, commit_async: bool, conf_options: array<string, string>} $consumerConfig
+     * @param array{topic: string, poll_timeout_ms: int, flush_timeout_ms: int, conf_options: array<string, string>}        $producerConfig
      */
     private function __construct(
         private readonly array $consumerConfig,
@@ -108,7 +108,9 @@ public static function fromDsn(#[\SensitiveParameter] string $dsn, array $option
         );
     }
 
-    /** @psalm-param array<string, bool|float|int|string|array<string>> $configOptions */
+    /**
+     * @param array<string, bool|float|int|string|array<string>> $configOptions
+     */
     private static function setupConsumerOptions(string $brokerList, array $configOptions): array
     {
         if (0 === \count($configOptions)) {
@@ -151,7 +153,9 @@ private static function setupConsumerOptions(string $brokerList, array $configOp
         return $options;
     }
 
-    /** @psalm-param array<string, bool|float|int|string|array<string>> $configOptions */
+    /**
+     * @param array<string, bool|float|int|string|array<string>> $configOptions
+     */
     private static function setupProducerOptions(string $brokerList, array $configOptions): array
     {
         if (0 === \count($configOptions)) {
@@ -276,7 +280,9 @@ public function ack(Message $message): void
         }
     }
 
-    /** @psalm-param array<string, string> $headers */
+    /**
+     * @param array<string, string> $headers
+     */
     public function publish(int $partition, int $messageFlags, string $body, string $key = null, array $headers = []): void
     {
         if (!$this->producerConfig['topic']) {
@@ -285,7 +291,6 @@ public function publish(int $partition, int $messageFlags, string $body, string
 
         $producer = $this->getProducer();
 
-        /** @psalm-var \RdKafka\ProducerTopic $topic */
         $topic = $producer->newTopic($this->producerConfig['topic']);
         $topic->producev(
             $partition,

diff --git a/src/Symfony/Component/Messenger/Bridge/Kafka/Transport/KafkaFactory.php b/src/Symfony/Component/Messenger/Bridge/Kafka/Transport/KafkaFactory.php
@@ -31,7 +31,9 @@ public function __construct(
     ) {
     }
 
-    /** @psalm-param array<string, string> $kafkaConfig */
+    /**
+     * @param array<string, string> $kafkaConfig
+     */
     public function createConsumer(array $kafkaConfig): KafkaConsumer
     {
         $conf = $this->getBaseConf();
@@ -55,7 +57,9 @@ public function createConsumer(array $kafkaConfig): KafkaConsumer
         return new KafkaConsumer($conf);
     }
 
-    /** @psalm-param array<string, string> $kafkaConfig */
+    /**
+     * @param array<string, string> $kafkaConfig
+     */
     public function createProducer(array $kafkaConfig): Producer
     {
         $conf = $this->getBaseConf();

diff --git a/src/Symfony/Component/Messenger/Bridge/Kafka/Transport/KafkaOption.php b/src/Symfony/Component/Messenger/Bridge/Kafka/Transport/KafkaOption.php
@@ -12,13 +12,13 @@
 namespace Symfony\Component\Messenger\Bridge\Kafka\Transport;
 
 /**
- * @SuppressWarnings(PHPMD.ExcessiveMethodLength)
- *
  * @see https://github.com/confluentinc/librdkafka/blob/master/CONFIGURATION.md
  */
 final class KafkaOption
 {
-    /** @psalm-return array<string, string> */
+    /**
+     * @return array<string, string>
+     */
     public static function consumer(): array
     {
         return array_merge(
@@ -59,7 +59,9 @@ public static function consumer(): array
         );
     }
 
-    /** @psalm-return array<string, string> */
+    /**
+     * @return array<string, string>
+     */
     public static function producer(): array
     {
         return array_merge(
@@ -100,7 +102,9 @@ public static function producer(): array
         );
     }
 
-    /** @psalm-return array<string, string> */
+    /**
+     * @return array<string, string>
+     */
     public static function global(): array
     {
         return [

diff --git a/src/Symfony/Component/Messenger/Bridge/Kafka/Transport/KafkaReceiver.php b/src/Symfony/Component/Messenger/Bridge/Kafka/Transport/KafkaReceiver.php
@@ -26,7 +26,6 @@ public function __construct(
     ) {
     }
 
-    /** @psalm-return \Traversable<Envelope> */
     public function get(): iterable
     {
         yield from $this->getEnvelope();
-Original file line number
+Diff line change
@@ Expand Up / @@ -26,7 +26,6 @@ public function __construct( @@
         ) {
         }
-        /** @psalm-return \Traversable<Envelope> */
         public function get(): iterable
         {
             yield from $this->getEnvelope();
@@ Expand Down @@