Improve documentation

saschpe · Mar 25, 2024 · 2ccccca · 2ccccca
1 parent 4b2a19d
commit 2ccccca
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 5 deletions.
diff --git a/log4k/src/commonMain/kotlin/saschpe/log4k/ConsoleLogger.kt b/log4k/src/commonMain/kotlin/saschpe/log4k/ConsoleLogger.kt
@@ -1,3 +1,6 @@
 package saschpe.log4k
 
+/**
+ * Log to the platform-specific console.
+ */
 expect class ConsoleLogger() : Logger
diff --git a/log4k/src/commonMain/kotlin/saschpe/log4k/Log.kt b/log4k/src/commonMain/kotlin/saschpe/log4k/Log.kt
@@ -9,6 +9,14 @@ import kotlin.native.concurrent.ThreadLocal
 object Log {
     enum class Level { Verbose, Debug, Info, Warning, Error, Assert }
 
+    /**
+     * List of logging "backends" to use, defaults to a [ConsoleLogger].
+     *
+     * You can add additional (custom) loggers, like a [FileLogger] with default parameters:
+     * ```kotlin
+     * Log.loggers += FileLogger()
+     * ```
+     */
     @JvmField
     val loggers = mutableListOf<Logger>(ConsoleLogger())
 
@@ -86,5 +94,14 @@ object Log {
         loggers.forEach { it.log(priority, tag, message, throwable) }
 }
 
-fun Any.logged(level: Log.Level = Log.Level.Debug) =
-    apply { Log.log(level, message = toString(), tag = this::class.simpleName ?: "") }
+/**
+ * Log any Kotlin object, like:
+ *
+ * ```kotlin
+ * list(1,2,3).logged()
+ * mapOf("left" to "right").logged()
+ * Pair("Log4k", "rocks!").logged()
+ * ```
+ */
+inline fun <reified T : Any> T.logged(level: Log.Level = Log.Level.Debug): T =
+    apply { Log.log(level, message = toString(), tag = T::class.simpleName ?: "") }
diff --git a/log4k/src/commonTest/kotlin/saschpe/log4k/LoggedTest.kt b/log4k/src/commonTest/kotlin/saschpe/log4k/LoggedTest.kt
@@ -2,6 +2,7 @@ package saschpe.log4k
 
 import testing.TestLoggerTest
 import kotlin.test.Test
+import kotlin.test.assertEquals
 
 internal expect val expectedListTag: String
 internal expect val expectedMapTag: String
@@ -25,10 +26,11 @@ class LoggedTest : TestLoggerTest() {
         val list = listOf("Hello", "World")
 
         // Act
-        list.logged()
+        val returned: List<String> = list.logged()
 
         // Assert
-        assertTestLogger(Log.Level.Debug, "[Hello, World]", expectedListTag, null)
+        assertTestLogger(Log.Level.Debug, "[Hello, World]", "List", null)
+        assertEquals(list, returned)
     }
 
     @Test
@@ -40,6 +42,6 @@ class LoggedTest : TestLoggerTest() {
         map.logged()
 
         // Assert
-        assertTestLogger(Log.Level.Debug, "{Hello=World}", expectedMapTag, null)
+        assertTestLogger(Log.Level.Debug, "{Hello=World}", "Map", null)
     }
 }