docs: improve documentation

Author: yoimerdr

virtualjoystick/src/main/java/com/yoimerdr/android/virtualjoystick/api/drawable/DrawableBitCache.kt

@@ -5,11 +5,21 @@ import android.graphics.drawable.Drawable
 import androidx.core.graphics.drawable.toBitmap
 import com.yoimerdr.android.virtualjoystick.geometry.size.Size
 
+/**
+ * Cache a [Drawable] as a [Bitmap] to improve performance when drawing it multiple times.
+ *
+ * @param drawable The [Drawable] to cache.
+ * @param size The desired size of the [Bitmap]. If null, the intrinsic size of the [Drawable] will be used.
+ *
+ */
 class DrawableBitCache @JvmOverloads constructor(
     drawable: Drawable,
     size: Size? = null,
 ) {
 
+    /**
+     * The desired size of the bitmap.
+     * */
     var size = size
         set(value) {
             if (field != value) {
@@ -18,6 +28,9 @@ class DrawableBitCache @JvmOverloads constructor(
             }
         }
 
+    /**
+     * The drawable to be cached as a bitmap.
+     * */
     var drawable = drawable
         set(value) {
             if (field != value) {
@@ -26,6 +39,11 @@ class DrawableBitCache @JvmOverloads constructor(
             }
         }
 
+    /**
+     * The width of the bitmap.
+     *
+     * If [size] is null, it's the intrinsic width of the [drawable].
+     * */
     var width: Int
         get() = size?.width ?: drawable.intrinsicWidth
         set(value) {
@@ -38,6 +56,11 @@ class DrawableBitCache @JvmOverloads constructor(
             }
         }
 
+    /**
+     * The height of the bitmap.
+     *
+     * If [size] is null, it's the intrinsic height of the [drawable].
+     * */
     var height: Int
         get() = size?.height ?: drawable.intrinsicHeight
         set(value) {
@@ -52,6 +75,9 @@ class DrawableBitCache @JvmOverloads constructor(
 
     private var mBitmap: Bitmap? = null
 
+    /**
+     * The cached bitmap of the [drawable].
+     * */
     val bitmap: Bitmap
         get() {
             if (mBitmap == null)
@@ -63,6 +89,9 @@ class DrawableBitCache @JvmOverloads constructor(
             return mBitmap!!
         }
 
+    /**
+     * Recycles the cached bitmap.
+     * */
     fun recycle() {
         mBitmap?.recycle()
         mBitmap = null

virtualjoystick/src/main/java/com/yoimerdr/android/virtualjoystick/api/log/Logger.kt

@@ -1,7 +1,20 @@
 package com.yoimerdr.android.virtualjoystick.api.log
 
+/**
+ * A simple logging interface
+ * */
 interface Logger {
+    /**
+     * Log a message with info level.
+     * */
     fun log(message: Any, vararg others: Any)
+
+    /**
+     * Log a message with warn level.
+     * */
     fun warn(message: Any, vararg others: Any)
+    /**
+     * Log a message with error level.
+     * */
     fun error(message: Any, vararg others: Any)
 }

virtualjoystick/src/main/java/com/yoimerdr/android/virtualjoystick/api/log/LoggerSupplier.kt

@@ -4,18 +4,34 @@ import android.util.Log
 import kotlin.reflect.KClass
 
 object LoggerSupplier {
+    /**
+     * Calls the specified function [block] with the [DefaultLogger] as its receiver.
+     * */
     fun withLogger(block: Logger.() -> Unit) {
         DefaultLogger.block()
     }
 
+    /**
+     * Calls the specified function [block] with a [LabeledLogger] as its receiver.
+     *
+     * The label is derived from the simple name of the provided [clazz].
+     * */
     fun withLogger(clazz: KClass<*>, block: Logger.() -> Unit) {
         withLogger(clazz.simpleName ?: "LOGGER", block)
     }
 
+    /**
+     * Calls the specified function [block] with a [LabeledLogger] as its receiver.
+     *
+     * The label is derived from the simple name of the provided [clazz].
+     * */
     fun withLogger(clazz: Class<*>, block: Logger.() -> Unit) {
         withLogger(clazz.simpleName ?: "LOGGER", block)
     }
 
+    /**
+     * Calls the specified function [block] with a [LabeledLogger] as its receiver.
+     * */
     fun withLogger(label: String, block: Logger.() -> Unit) {
         LabeledLogger(label)
             .block()
@@ -25,6 +41,13 @@ object LoggerSupplier {
         return "$message\n${others.joinToString("\n") { it.toString() }}"
     }
 
+    /**
+     * The default logger implementation that logs to Logcat with the tag "LOG", "WARN", and "ERROR".
+     *
+     * @see [Log.d]
+     * @see [Log.w]
+     * @see [Log.e]
+     * */
     object DefaultLogger : Logger {
         override fun log(message: Any, vararg others: Any) {
             Log.d("LOG", createMessage(message, others))
@@ -39,6 +62,15 @@ object LoggerSupplier {
         }
     }
 
+    /**
+     * A logger implementation that logs to Logcat with a custom label.
+     *
+     * @param label The label to use for logging.
+     *
+     * @see [Log.d]
+     * @see [Log.w]
+     * @see [Log.e]
+     * */
     class LabeledLogger(private val label: String) : Logger {
         override fun log(message: Any, vararg others: Any) {
             Log.d(label, createMessage(message, others))

virtualjoystick/src/main/java/com/yoimerdr/android/virtualjoystick/control/ArcControl.kt

@@ -4,7 +4,7 @@ import com.yoimerdr.android.virtualjoystick.drawer.shapes.arc.ArcDrawer
 import com.yoimerdr.android.virtualjoystick.theme.ColorsScheme
 
 /**
- * [Control] that uses by default by the [ArcDrawer].
+ * [Control] that uses by default the [ArcDrawer] as drawer.
  */
 open class ArcControl(
     colors: ColorsScheme,

virtualjoystick/src/main/java/com/yoimerdr/android/virtualjoystick/control/CircleArcControl.kt

@@ -4,7 +4,7 @@ import com.yoimerdr.android.virtualjoystick.drawer.shapes.arc.CircleArcDrawer
 import com.yoimerdr.android.virtualjoystick.theme.ColorsScheme
 
 /**
- * [Control] that uses by default by the [CircleArcDrawer.withRatio].
+ * [Control] that uses by default the [CircleArcDrawer.withRatio] as drawer.
  */
 open class CircleArcControl(
     colors: ColorsScheme,

virtualjoystick/src/main/java/com/yoimerdr/android/virtualjoystick/control/CircleControl.kt

@@ -4,7 +4,7 @@ import com.yoimerdr.android.virtualjoystick.drawer.shapes.circle.CircleDrawer
 import com.yoimerdr.android.virtualjoystick.theme.ColorsScheme
 
 /**
- * [Control] that uses by default by the [CircleDrawer] with [CircleDrawer.withRatio].
+ * [Control] that uses by default the [CircleDrawer.withRatio] as drawer.
  */
 open class CircleControl(
     colors: ColorsScheme,