Add scaladoc

fd4s · Jun 15, 2021 · 36c2941 · 36c2941
1 parent a117de7
commit 36c2941
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/modules/core/src/main/scala/fs2/kafka/KafkaProducer.scala b/modules/core/src/main/scala/fs2/kafka/KafkaProducer.scala
@@ -54,14 +54,33 @@ abstract class KafkaProducer[F[_], K, V] {
     records: ProducerRecords[K, V, P]
   ): F[F[ProducerResult[K, V, P]]]
 
+  /**
+    * Produces the specified [[ProducerRecords]] without a passthrough value, 
+    * see [[produce]] for general semantics.
+    */
   def produce_(records: ProducerRecords[K, V, _]): F[F[Chunk[(ProducerRecord[K, V], RecordMetadata)]]]
 
+  /**
+    * Produce a single [[ProducerRecord]], see [[produce]] for general semantics.
+    */
   def produceOne[P](record: ProducerRecord[K, V], passthrough: P): F[F[ProducerResult[K, V, P]]]
 
+  /**
+    * Produce a single record to the specified topic using the provided key and value,
+    * see [[produce]] for general semantics.
+    */
   def produceOne[P](topic: String, key: K, value: V, passthrough: P): F[F[ProducerResult[K, V, P]]]
 
+  /**
+    * Produce a single [[ProducerRecord]] without a passthrough value,
+    * see [[produce]] for general semantics.
+    */
   def produceOne_(producerRecord: ProducerRecord[K, V]): F[F[RecordMetadata]]
 
+  /**
+    * Produce a single record to the specified topic using the provided key and value
+    * without a passthrough value, see [[produce]] for general semantics.
+    */
   def produceOne_(topic: String, key: K, value: V): F[F[RecordMetadata]]
 }