From d1234ce48fddd2d0316d85c97898e94387c9a62d Mon Sep 17 00:00:00 2001
From: Greg Giacovelli <greg.giacovelli@gotinder.com>
Date: Wed, 22 Dec 2021 14:29:45 -0800
Subject: [PATCH] Documentation

---
 .../coroutines/CoroutinesStreamAdapterFactory.kt              | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/scarlet-stream-adapter-coroutines/src/main/java/com/tinder/streamadapter/coroutines/CoroutinesStreamAdapterFactory.kt b/scarlet-stream-adapter-coroutines/src/main/java/com/tinder/streamadapter/coroutines/CoroutinesStreamAdapterFactory.kt
index 051a2953..49b77d6c 100644
--- a/scarlet-stream-adapter-coroutines/src/main/java/com/tinder/streamadapter/coroutines/CoroutinesStreamAdapterFactory.kt
+++ b/scarlet-stream-adapter-coroutines/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