Remove TODOs

Author: felixschlegel

Sources/SwiftKafka/KafkaBackPressurePollingSystem.swift

@@ -27,7 +27,7 @@ final class KafkaBackPressurePollingSystem {
     /// The state machine that manages the system's state transitions.
     let stateMachineLock: NIOLockedValueBox<StateMachine>
 
-    // TODO: docc
+    /// Closure that takes care of polling `librdkafka` for new messages.
     var pollClosure: (() -> Void)?
     /// The ``NIOAsyncSequenceProducer.Source`` used for yielding the messages to the ``NIOAsyncSequenceProducer``.
     var sequenceSource: Producer.Source? {

Sources/SwiftKafka/KafkaProducer.swift

@@ -69,8 +69,8 @@ public actor KafkaProducer {
     private var client: KafkaClient
     /// Mechanism that polls the Kafka cluster for updates periodically.
     private let pollingSystem: KafkaBackPressurePollingSystem
-    // TODO: docc
-    private var runTask: Task<Void, Never>?
+    /// Task that polls `librdkafka` for new acknowledgements at regular intervals.
+    private var pollTask: Task<Void, Never>?
 
     /// `AsyncSequence` that returns all ``KafkaProducerMessage`` objects that have been
     /// acknowledged by the Kafka cluster.
@@ -121,8 +121,7 @@ public actor KafkaProducer {
 
         self.client = try KafkaClient(type: .producer, config: config, logger: self.logger)
 
-        // TODO: expose run to user?
-        self.runTask = Task { [pollingSystem] in
+        self.pollTask = Task { [pollingSystem] in
             await pollingSystem.run(pollInterval: .milliseconds(100))
         }
 
@@ -179,8 +178,7 @@ public actor KafkaProducer {
             rd_kafka_topic_destroy(topicHandle)
         }
 
-        // TODO: kill PollingSystem
-        self.runTask?.cancel()
+        self.pollTask?.cancel()
 
         self.state = .shutDown
     }