Add kdoc for the standardFormat option

ktorio · Dec 26, 2024 · a6b943a · a6b943a
1 parent a108591
commit a6b943a
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/...r-client-plugins/ktor-client-logging/common/src/io/ktor/client/plugins/logging/Logging.kt b/...r-client-plugins/ktor-client-logging/common/src/io/ktor/client/plugins/logging/Logging.kt
@@ -39,6 +39,10 @@ public class LoggingConfig {
 
     private var _logger: Logger? = null
 
+    /**
+     * If true, turns on the [OkHttp logging format](https://github.com/square/okhttp/blob/master/okhttp-logging-interceptor/src/main/kotlin/okhttp3/logging/HttpLoggingInterceptor.kt#L56).
+     * Writes only application-level logs because the low-level HTTP communication is hidden within the engine implementations.
+     */
     public var standardFormat: Boolean = false
 
     /**