Documentation

Tinder · Dec 22, 2021 · d1234ce · d1234ce
1 parent 8b1c631
commit d1234ce
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/...tines/src/main/java/com/tinder/streamadapter/coroutines/CoroutinesStreamAdapterFactory.kt b/...tines/src/main/java/com/tinder/streamadapter/coroutines/CoroutinesStreamAdapterFactory.kt
@@ -11,7 +11,9 @@ import kotlinx.coroutines.flow.Flow
 import java.lang.reflect.Type
 
 /**
- * A [stream adapter factory][StreamAdapter.Factory] that uses ReceiveChannel.
+ * A [stream adapter factory][StreamAdapter.Factory] that allows for [ReceiveChannel]
+ * and [Flow] based streams.
+ * [bufferSize] is configurable for the underlying channels, defaults to [DEFAULT_BUFFER]
  */
 private const val DEFAULT_BUFFER = 128