From 5bfc66767567245d459239ea4cf03cdc99d9aeaa Mon Sep 17 00:00:00 2001
From: Adam Semenenko <152864218+adam-enko@users.noreply.github.com>
Date: Tue, 1 Oct 2024 10:34:44 +0200
Subject: [PATCH] update LoggerAdapter kdoc

---
 .../src/main/kotlin/internal/LoggerAdapter.kt          | 10 +++++++---
 1 file changed, 7 insertions(+), 3 deletions(-)

diff --git a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/internal/LoggerAdapter.kt b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/internal/LoggerAdapter.kt
index a79e9809ba..0733a77e62 100644
--- a/dokka-runners/dokka-gradle-plugin/src/main/kotlin/internal/LoggerAdapter.kt
+++ b/dokka-runners/dokka-gradle-plugin/src/main/kotlin/internal/LoggerAdapter.kt
@@ -3,17 +3,21 @@
  */
 package org.jetbrains.dokka.gradle.internal
 
-import org.gradle.api.logging.Logger
 import org.jetbrains.dokka.utilities.DokkaLogger
 import org.jetbrains.dokka.utilities.LoggingLevel
 import org.jetbrains.dokka.utilities.LoggingLevel.*
+import org.slf4j.Logger
 import java.io.File
 import java.io.Writer
 import java.util.concurrent.atomic.AtomicInteger
 
 /**
- * Logs all Dokka messages to [logWriter],
- * and redirects all messages to [logger].
+ * A logger for [org.jetbrains.dokka.DokkaGenerator].
+ *
+ * All messages will be written to [logWriter] and forwarded to a Gradle [logger] (at an appropriate log level).
+ *
+ * [org.jetbrains.dokka.DokkaGenerator] makes heavy use of coroutines and parallelization,
+ * so use thread-safe practices when handling logging messages.
  *
  * @param logTag Prepend all [logger] messages with this tag.
  * @see org.jetbrains.dokka.DokkaGenerator