code cleanup

woltapp · Jun 22, 2020 · 539cf8a · 539cf8a
1 parent 6e75e07
commit 539cf8a
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/Kotlin/lib/src/main/java/com/wolt/blurhashkt/BlurHashDecoder.kt b/Kotlin/lib/src/main/java/com/wolt/blurhashkt/BlurHashDecoder.kt
@@ -24,6 +24,13 @@ object BlurHashDecoder {
         cacheCosinesY.clear()
     }
 
+    /**
+     * Decode a blur hash into a new bitmap.
+     *
+     * @param useCache use in memory cache for the calculated math, reused by images with same size.
+     *                 if the cache does not exist yet it will be created and populated with new calculations.
+     *                 By default it is true.
+     */
     fun decode(blurHash: String?, width: Int, height: Int, punch: Float = 1f, useCache: Boolean = true): Bitmap? {
         if (blurHash == null || blurHash.length < 6) {
             return null