From 78d1f504b630ce67dfca71d5a678b32ae41616c3 Mon Sep 17 00:00:00 2001 From: Chanjung Kim Date: Mon, 18 Mar 2024 00:59:33 +0900 Subject: [PATCH] chore: fix typos in generated KDoc of getAsFlow --- .../org/jetbrains/compose/resources/ResourcesSpec.kt | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/gradle-plugins/compose/src/main/kotlin/org/jetbrains/compose/resources/ResourcesSpec.kt b/gradle-plugins/compose/src/main/kotlin/org/jetbrains/compose/resources/ResourcesSpec.kt index 48033d45f4..e4d35becf9 100644 --- a/gradle-plugins/compose/src/main/kotlin/org/jetbrains/compose/resources/ResourcesSpec.kt +++ b/gradle-plugins/compose/src/main/kotlin/org/jetbrains/compose/resources/ResourcesSpec.kt @@ -160,15 +160,15 @@ internal fun getResFileSpecs( """ Returns a flow which emits the content of the resource file as byte array chunks. The length of each chunk is not empty and has the length of [byteCount] or smaller. The flow will throw - [MissingResourceException] when the resource file is missing or [ResourceIOException] if any IO - error occurs. You can catch those with the [catch][kotlinx.coroutines.flow.catch] operator. This - function is useful when the resource is too big to be contained in a single [ByteArray]. + [MissingResourceException][org.jetbrains.compose.resources.MissingResourceException] when the + resource file is missing or [ResourceIOException][org.jetbrains.compose.resources.ResourceIOException] + if any IO error occurs. You can catch those with the [catch][kotlinx.coroutines.flow.catch] operator. + This function is useful when the resource is too big to be contained in a single [ByteArray]. Example: `val bytes = Res.getAsFlow("files/key.bin").collectToList().flatten()` @param path The path of the file to read in the resource's directory. - @param byteCount The maximum length of the emitted byte arrays. The flow can emit an array smaller - than this length. + @param byteCount The maximum length of the emitted byte arrays. The flow can emit an array smaller than this length. @return A flow that emits the content of the file as byte sub-arrays.