docs: Improve documentation

panpf · Aug 2, 2024 · af83b19 · af83b19
1 parent 5dd7809
commit af83b19
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/sketch-core/src/desktopMain/kotlin/com/github/panpf/sketch/fetch/KotlinResourceUriFetcher.kt b/sketch-core/src/desktopMain/kotlin/com/github/panpf/sketch/fetch/KotlinResourceUriFetcher.kt
@@ -15,6 +15,8 @@ fun newKotlinResourceUri(resourceName: String): String =
 
 /**
  * Check if the uri is a Kotlin resource uri
+ *
+ * Sample: 'file:///kotlin_resource/test.png'
  */
 fun isKotlinResourceUri(uri: Uri): Boolean =
     KotlinResourceUriFetcher.SCHEME.equals(uri.scheme, ignoreCase = true)

diff --git a/sketch-core/src/iosMain/kotlin/com/github/panpf/sketch/fetch/KotlinResourceUriFetcher.kt b/sketch-core/src/iosMain/kotlin/com/github/panpf/sketch/fetch/KotlinResourceUriFetcher.kt
@@ -15,6 +15,8 @@ fun newKotlinResourceUri(resourceName: String): String =
 
 /**
  * Check if the uri is a Kotlin resource uri
+ *
+ * Sample: 'file:///kotlin_resource/test.png'
  */
 fun isKotlinResourceUri(uri: Uri): Boolean =
     KotlinResourceUriFetcher.SCHEME.equals(uri.scheme, ignoreCase = true)