diff --git a/docs/index.md b/docs/index.md index fb078b5..0ef4452 100644 --- a/docs/index.md +++ b/docs/index.md @@ -6,3 +6,4 @@ |---| | [logger-android-timber](logger-android-timber/index.md) | | | [logger-core](logger-core/index.md) | | +| [logger-ktor-client](logger-ktor-client/index.md) | | diff --git a/docs/logger-android-timber/logger-android-timber/com.chrynan.logger.android.timber/-timber-logger/index.md b/docs/logger-android-timber/logger-android-timber/com.chrynan.logger.android.timber/-timber-logger/index.md index 80ab0c5..6eaa1cf 100644 --- a/docs/logger-android-timber/logger-android-timber/com.chrynan.logger.android.timber/-timber-logger/index.md +++ b/docs/logger-android-timber/logger-android-timber/com.chrynan.logger.android.timber/-timber-logger/index.md @@ -5,18 +5,18 @@ [androidJvm]\ abstract class [TimberLogger](index.md) : [LogInitializer](../../../../logger-core/logger-core/com.chrynan.logger/-log-initializer/index.md), [Logger](../../../../logger-core/logger-core/com.chrynan.logger/-logger/index.md) +## Constructors + +| | | +|---|---| +| [TimberLogger](-timber-logger.md) | [androidJvm]
fun [TimberLogger](-timber-logger.md)() | + ## Functions | Name | Summary | |---|---| -| [debug](index.md#528699424%2FFunctions%2F1672300378) | [androidJvm]
open fun [debug](index.md#528699424%2FFunctions%2F1672300378)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)?) | -| [error](index.md#-1522606379%2FFunctions%2F1672300378) | [androidJvm]
open fun [error](index.md#-1522606379%2FFunctions%2F1672300378)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)?) | -| [info](index.md#1308495187%2FFunctions%2F1672300378) | [androidJvm]
open fun [info](index.md#1308495187%2FFunctions%2F1672300378)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)?) | | [init](index.md#1639196271%2FFunctions%2F1672300378) | [androidJvm]
abstract fun [init](index.md#1639196271%2FFunctions%2F1672300378)() | | [log](log.md) | [androidJvm]
open override fun [log](log.md)(logType: [LogType](../../../../logger-core/logger-core/com.chrynan.logger/-log-type/index.md), tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)?) | -| [verbose](index.md#-736659633%2FFunctions%2F1672300378) | [androidJvm]
open fun [verbose](index.md#-736659633%2FFunctions%2F1672300378)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)?) | -| [warning](index.md#1679762281%2FFunctions%2F1672300378) | [androidJvm]
open fun [warning](index.md#1679762281%2FFunctions%2F1672300378)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)?) | -| [wtf](index.md#-1842084362%2FFunctions%2F1672300378) | [androidJvm]
open fun [wtf](index.md#-1842084362%2FFunctions%2F1672300378)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)?) | ## Properties diff --git a/docs/logger-core/logger-core/com.chrynan.logger/-async-logger/-async-logger.md b/docs/logger-core/logger-core/com.chrynan.logger/-async-logger/-async-logger.md new file mode 100644 index 0000000..5d657a4 --- /dev/null +++ b/docs/logger-core/logger-core/com.chrynan.logger/-async-logger/-async-logger.md @@ -0,0 +1,6 @@ +//[logger-core](../../../index.md)/[com.chrynan.logger](../index.md)/[AsyncLogger](index.md)/[AsyncLogger](-async-logger.md) + +# AsyncLogger + +[common]\ +fun [AsyncLogger](-async-logger.md)() diff --git a/docs/logger-core/logger-core/com.chrynan.logger/-async-logger/index.md b/docs/logger-core/logger-core/com.chrynan.logger/-async-logger/index.md new file mode 100644 index 0000000..e2d531e --- /dev/null +++ b/docs/logger-core/logger-core/com.chrynan.logger/-async-logger/index.md @@ -0,0 +1,40 @@ +//[logger-core](../../../index.md)/[com.chrynan.logger](../index.md)/[AsyncLogger](index.md) + +# AsyncLogger + +[common]\ +abstract class [AsyncLogger](index.md) : [Logger](../-logger/index.md) + +An abstract class implementation of the [Logger](../-logger/index.md) interface allowing for use of kotlin coroutines and suspend functions. This effectively allows for asynchronous logging of messages. + +Example usage: + +```kotlin +class MyAsyncLogger( + override val coroutineScope: CoroutineScope, + private val api: Api +) : AsyncLogger() { + + override suspend fun logAsync(logType: LogType, tag: String, message: String?, throwable: Throwable?) { + api.logMessage(message).await() + } +} +``` + +## Constructors + +| | | +|---|---| +| [AsyncLogger](-async-logger.md) | [common]
fun [AsyncLogger](-async-logger.md)() | + +## Functions + +| Name | Summary | +|---|---| +| [log](log.md) | [common]
override fun [log](log.md)(logType: [LogType](../-log-type/index.md), tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)?)
Performs the action to log the provided details. | + +## Properties + +| Name | Summary | +|---|---| +| [isEnabled](is-enabled.md) | [common]
open override var [isEnabled](is-enabled.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false
Determines whether this [Logger](../-logger/index.md) instance should be used to output logs. The default value is up to the implementation and platform, but generally should be `false` to prevent accidental logging in a production environment. Explicitly set the value to be certain whether logging is enabled or not. | diff --git a/docs/logger-core/logger-core/com.chrynan.logger/-async-logger/is-enabled.md b/docs/logger-core/logger-core/com.chrynan.logger/-async-logger/is-enabled.md new file mode 100644 index 0000000..29ee303 --- /dev/null +++ b/docs/logger-core/logger-core/com.chrynan.logger/-async-logger/is-enabled.md @@ -0,0 +1,10 @@ +//[logger-core](../../../index.md)/[com.chrynan.logger](../index.md)/[AsyncLogger](index.md)/[isEnabled](is-enabled.md) + +# isEnabled + +[common]\ +open override var [isEnabled](is-enabled.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false + +Determines whether this [Logger](../-logger/index.md) instance should be used to output logs. The default value is up to the implementation and platform, but generally should be `false` to prevent accidental logging in a production environment. Explicitly set the value to be certain whether logging is enabled or not. + +**Note:** that it is up to the [Logger](../-logger/index.md) implementation to prevent logging if this value returns `false`. diff --git a/docs/logger-core/logger-core/com.chrynan.logger/-async-logger/log.md b/docs/logger-core/logger-core/com.chrynan.logger/-async-logger/log.md new file mode 100644 index 0000000..dde8f7b --- /dev/null +++ b/docs/logger-core/logger-core/com.chrynan.logger/-async-logger/log.md @@ -0,0 +1,8 @@ +//[logger-core](../../../index.md)/[com.chrynan.logger](../index.md)/[AsyncLogger](index.md)/[log](log.md) + +# log + +[common]\ +override fun [log](log.md)(logType: [LogType](../-log-type/index.md), tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)?) + +Performs the action to log the provided details. diff --git a/docs/logger-core/logger-core/com.chrynan.logger/-console-logger/index.md b/docs/logger-core/logger-core/com.chrynan.logger/-console-logger/index.md index 3e6f37e..702763a 100644 --- a/docs/logger-core/logger-core/com.chrynan.logger/-console-logger/index.md +++ b/docs/logger-core/logger-core/com.chrynan.logger/-console-logger/index.md @@ -5,21 +5,21 @@ [js]\ open class [ConsoleLogger](index.md) : [LogInitializer](../../../../logger-core/logger-core/com.chrynan.logger/-log-initializer/index.md), [Logger](../../../../logger-core/logger-core/com.chrynan.logger/-logger/index.md) +## Constructors + +| | | +|---|---| +| [ConsoleLogger](-console-logger.md) | [js]
fun [ConsoleLogger](-console-logger.md)() | + ## Functions | Name | Summary | |---|---| -| [debug](index.md#528699424%2FFunctions%2F332244294) | [js]
open fun [debug](index.md#528699424%2FFunctions%2F332244294)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) | -| [error](index.md#-1522606379%2FFunctions%2F332244294) | [js]
open fun [error](index.md#-1522606379%2FFunctions%2F332244294)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) | -| [info](index.md#1308495187%2FFunctions%2F332244294) | [js]
open fun [info](index.md#1308495187%2FFunctions%2F332244294)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) | | [init](init.md) | [js]
open override fun [init](init.md)() | -| [log](log.md) | [js]
open override fun [log](log.md)(logType: [LogType](../../../../logger-core/logger-core/com.chrynan.logger/-log-type/index.md), tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)?) | -| [verbose](index.md#-736659633%2FFunctions%2F332244294) | [js]
open fun [verbose](index.md#-736659633%2FFunctions%2F332244294)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) | -| [warning](index.md#1679762281%2FFunctions%2F332244294) | [js]
open fun [warning](index.md#1679762281%2FFunctions%2F332244294)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) | -| [wtf](index.md#-1842084362%2FFunctions%2F332244294) | [js]
open fun [wtf](index.md#-1842084362%2FFunctions%2F332244294)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) | +| [log](log.md) | [js]
open override fun [log](log.md)(logType: [LogType](../../../../logger-core/logger-core/com.chrynan.logger/-log-type/index.md), tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)?)
Performs the action to log the provided details. | ## Properties | Name | Summary | |---|---| -| [isEnabled](is-enabled.md) | [js]
open override var [isEnabled](is-enabled.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = true
Determines whether this [Logger](../../../../logger-core/logger-core/com.chrynan.logger/-logger/index.md) instance should be used to output logs. This value should default to true. | +| [isEnabled](is-enabled.md) | [js]
open override var [isEnabled](is-enabled.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false
Determines whether this [Logger](../../../../logger-core/logger-core/com.chrynan.logger/-logger/index.md) instance should be used to output logs. The default value is up to the implementation and platform, but generally should be `false` to prevent accidental logging in a production environment. Explicitly set the value to be certain whether logging is enabled or not. | diff --git a/docs/logger-core/logger-core/com.chrynan.logger/-console-logger/is-enabled.md b/docs/logger-core/logger-core/com.chrynan.logger/-console-logger/is-enabled.md index ab6db31..f0b6c95 100644 --- a/docs/logger-core/logger-core/com.chrynan.logger/-console-logger/is-enabled.md +++ b/docs/logger-core/logger-core/com.chrynan.logger/-console-logger/is-enabled.md @@ -3,8 +3,8 @@ # isEnabled [js]\ -open override var [isEnabled](is-enabled.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = true +open override var [isEnabled](is-enabled.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false -Determines whether this [Logger](../../../../logger-core/logger-core/com.chrynan.logger/-logger/index.md) instance should be used to output logs. This value should default to true. +Determines whether this [Logger](../../../../logger-core/logger-core/com.chrynan.logger/-logger/index.md) instance should be used to output logs. The default value is up to the implementation and platform, but generally should be `false` to prevent accidental logging in a production environment. Explicitly set the value to be certain whether logging is enabled or not. -**Note:** that it is up to the call-site to prevent logging if this value returns false. +**Note:** that it is up to the [Logger](../../../../logger-core/logger-core/com.chrynan.logger/-logger/index.md) implementation to prevent logging if this value returns `false`. diff --git a/docs/logger-core/logger-core/com.chrynan.logger/-console-logger/log.md b/docs/logger-core/logger-core/com.chrynan.logger/-console-logger/log.md index 4d870f7..741daf6 100644 --- a/docs/logger-core/logger-core/com.chrynan.logger/-console-logger/log.md +++ b/docs/logger-core/logger-core/com.chrynan.logger/-console-logger/log.md @@ -4,3 +4,5 @@ [js]\ open override fun [log](log.md)(logType: [LogType](../../../../logger-core/logger-core/com.chrynan.logger/-log-type/index.md), tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)?) + +Performs the action to log the provided details. diff --git a/docs/logger-core/logger-core/com.chrynan.logger/-delegating-logger/equals.md b/docs/logger-core/logger-core/com.chrynan.logger/-delegating-logger/equals.md new file mode 100644 index 0000000..63d22e4 --- /dev/null +++ b/docs/logger-core/logger-core/com.chrynan.logger/-delegating-logger/equals.md @@ -0,0 +1,6 @@ +//[logger-core](../../../index.md)/[com.chrynan.logger](../index.md)/[DelegatingLogger](index.md)/[equals](equals.md) + +# equals + +[common]\ +open operator override fun [equals](equals.md)(other: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)?): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) diff --git a/docs/logger-core/logger-core/com.chrynan.logger/-delegating-logger/hash-code.md b/docs/logger-core/logger-core/com.chrynan.logger/-delegating-logger/hash-code.md new file mode 100644 index 0000000..6cc494f --- /dev/null +++ b/docs/logger-core/logger-core/com.chrynan.logger/-delegating-logger/hash-code.md @@ -0,0 +1,6 @@ +//[logger-core](../../../index.md)/[com.chrynan.logger](../index.md)/[DelegatingLogger](index.md)/[hashCode](hash-code.md) + +# hashCode + +[common]\ +open override fun [hashCode](hash-code.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) diff --git a/docs/logger-core/logger-core/com.chrynan.logger/-delegating-logger/index.md b/docs/logger-core/logger-core/com.chrynan.logger/-delegating-logger/index.md index 48c8338..dc36f3c 100644 --- a/docs/logger-core/logger-core/com.chrynan.logger/-delegating-logger/index.md +++ b/docs/logger-core/logger-core/com.chrynan.logger/-delegating-logger/index.md @@ -3,7 +3,7 @@ # DelegatingLogger [common]\ -class [DelegatingLogger](index.md)(loggers: [Set](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html)<[Logger](../-logger/index.md)>, delegateIsEnabledChanges: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) : [Logger](../-logger/index.md), [LogInitializer](../-log-initializer/index.md) +class [DelegatingLogger](index.md)(loggers: [Set](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html)<[Logger](../-logger/index.md)>, delegateIsEnabledChanges: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false) : [Logger](../-logger/index.md), [LogInitializer](../-log-initializer/index.md) A [Logger](../-logger/index.md) implementation that delegates to the provided [loggers](../../../../logger-core/com.chrynan.logger/-delegating-logger/loggers.md). This allows for using multiple [Logger](../-logger/index.md)s. @@ -17,17 +17,14 @@ A [Logger](../-logger/index.md) implementation that delegates to the provided [l | Name | Summary | |---|---| -| [debug](../-logger/debug.md) | [common]
open fun [debug](../-logger/debug.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) | -| [error](../-logger/error.md) | [common]
open fun [error](../-logger/error.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) | -| [info](../-logger/info.md) | [common]
open fun [info](../-logger/info.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) | +| [equals](equals.md) | [common]
open operator override fun [equals](equals.md)(other: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)?): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [hashCode](hash-code.md) | [common]
open override fun [hashCode](hash-code.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | | [init](init.md) | [common]
open override fun [init](init.md)() | -| [log](log.md) | [common]
open override fun [log](log.md)(logType: [LogType](../-log-type/index.md), tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)?) | -| [verbose](../-logger/verbose.md) | [common]
open fun [verbose](../-logger/verbose.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) | -| [warning](../-logger/warning.md) | [common]
open fun [warning](../-logger/warning.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) | -| [wtf](../-logger/wtf.md) | [common]
open fun [wtf](../-logger/wtf.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) | +| [log](log.md) | [common]
open override fun [log](log.md)(logType: [LogType](../-log-type/index.md), tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)?)
Performs the action to log the provided details. | +| [toString](to-string.md) | [common]
open override fun [toString](to-string.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | ## Properties | Name | Summary | |---|---| -| [isEnabled](is-enabled.md) | [common]
open override var [isEnabled](is-enabled.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = true
Determines whether this [Logger](../-logger/index.md) instance should be used to output logs. This value should default to true. | +| [isEnabled](is-enabled.md) | [common]
open override var [isEnabled](is-enabled.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false
Determines whether this [Logger](../-logger/index.md) instance should be used to output logs. The default value is up to the implementation and platform, but generally should be `false` to prevent accidental logging in a production environment. Explicitly set the value to be certain whether logging is enabled or not. | diff --git a/docs/logger-core/logger-core/com.chrynan.logger/-delegating-logger/is-enabled.md b/docs/logger-core/logger-core/com.chrynan.logger/-delegating-logger/is-enabled.md index b958db3..2d03e1a 100644 --- a/docs/logger-core/logger-core/com.chrynan.logger/-delegating-logger/is-enabled.md +++ b/docs/logger-core/logger-core/com.chrynan.logger/-delegating-logger/is-enabled.md @@ -3,8 +3,8 @@ # isEnabled [common]\ -open override var [isEnabled](is-enabled.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = true +open override var [isEnabled](is-enabled.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false -Determines whether this [Logger](../-logger/index.md) instance should be used to output logs. This value should default to true. +Determines whether this [Logger](../-logger/index.md) instance should be used to output logs. The default value is up to the implementation and platform, but generally should be `false` to prevent accidental logging in a production environment. Explicitly set the value to be certain whether logging is enabled or not. -**Note:** that it is up to the call-site to prevent logging if this value returns false. +**Note:** that it is up to the [Logger](../-logger/index.md) implementation to prevent logging if this value returns `false`. diff --git a/docs/logger-core/logger-core/com.chrynan.logger/-delegating-logger/log.md b/docs/logger-core/logger-core/com.chrynan.logger/-delegating-logger/log.md index f06eb73..e503220 100644 --- a/docs/logger-core/logger-core/com.chrynan.logger/-delegating-logger/log.md +++ b/docs/logger-core/logger-core/com.chrynan.logger/-delegating-logger/log.md @@ -4,3 +4,5 @@ [common]\ open override fun [log](log.md)(logType: [LogType](../-log-type/index.md), tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)?) + +Performs the action to log the provided details. diff --git a/docs/logger-core/logger-core/com.chrynan.logger/-delegating-logger/to-string.md b/docs/logger-core/logger-core/com.chrynan.logger/-delegating-logger/to-string.md new file mode 100644 index 0000000..a176e38 --- /dev/null +++ b/docs/logger-core/logger-core/com.chrynan.logger/-delegating-logger/to-string.md @@ -0,0 +1,6 @@ +//[logger-core](../../../index.md)/[com.chrynan.logger](../index.md)/[DelegatingLogger](index.md)/[toString](to-string.md) + +# toString + +[common]\ +open override fun [toString](to-string.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) diff --git a/docs/logger-core/logger-core/com.chrynan.logger/-java-annotation-processor-messager-logger/index.md b/docs/logger-core/logger-core/com.chrynan.logger/-java-annotation-processor-messager-logger/index.md index 3e071ce..a3c6df5 100644 --- a/docs/logger-core/logger-core/com.chrynan.logger/-java-annotation-processor-messager-logger/index.md +++ b/docs/logger-core/logger-core/com.chrynan.logger/-java-annotation-processor-messager-logger/index.md @@ -5,21 +5,21 @@ [jvm]\ open class [JavaAnnotationProcessorMessagerLogger](index.md)(messager: [Messager](https://docs.oracle.com/javase/8/docs/api/javax/annotation/processing/Messager.html)) : [Logger](../../../../logger-core/logger-core/com.chrynan.logger/-logger/index.md), [LogInitializer](../../../../logger-core/logger-core/com.chrynan.logger/-log-initializer/index.md) +## Constructors + +| | | +|---|---| +| [JavaAnnotationProcessorMessagerLogger](-java-annotation-processor-messager-logger.md) | [jvm]
fun [JavaAnnotationProcessorMessagerLogger](-java-annotation-processor-messager-logger.md)(messager: [Messager](https://docs.oracle.com/javase/8/docs/api/javax/annotation/processing/Messager.html)) | + ## Functions | Name | Summary | |---|---| -| [debug](../-java-logger/index.md#528699424%2FFunctions%2F1038150354) | [jvm]
open fun [debug](../-java-logger/index.md#528699424%2FFunctions%2F1038150354)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) | -| [error](../-java-logger/index.md#-1522606379%2FFunctions%2F1038150354) | [jvm]
open fun [error](../-java-logger/index.md#-1522606379%2FFunctions%2F1038150354)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) | -| [info](../-java-logger/index.md#1308495187%2FFunctions%2F1038150354) | [jvm]
open fun [info](../-java-logger/index.md#1308495187%2FFunctions%2F1038150354)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) | | [init](init.md) | [jvm]
open override fun [init](init.md)() | -| [log](log.md) | [jvm]
open override fun [log](log.md)(logType: [LogType](../../../../logger-core/logger-core/com.chrynan.logger/-log-type/index.md), tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)?) | -| [verbose](../-java-logger/index.md#-736659633%2FFunctions%2F1038150354) | [jvm]
open fun [verbose](../-java-logger/index.md#-736659633%2FFunctions%2F1038150354)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) | -| [warning](../-java-logger/index.md#1679762281%2FFunctions%2F1038150354) | [jvm]
open fun [warning](../-java-logger/index.md#1679762281%2FFunctions%2F1038150354)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) | -| [wtf](../-java-logger/index.md#-1842084362%2FFunctions%2F1038150354) | [jvm]
open fun [wtf](../-java-logger/index.md#-1842084362%2FFunctions%2F1038150354)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) | +| [log](log.md) | [jvm]
open override fun [log](log.md)(logType: [LogType](../../../../logger-core/logger-core/com.chrynan.logger/-log-type/index.md), tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)?)
Performs the action to log the provided details. | ## Properties | Name | Summary | |---|---| -| [isEnabled](is-enabled.md) | [jvm]
open override var [isEnabled](is-enabled.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = true
Determines whether this [Logger](../../../../logger-core/logger-core/com.chrynan.logger/-logger/index.md) instance should be used to output logs. This value should default to true. | +| [isEnabled](is-enabled.md) | [jvm]
open override var [isEnabled](is-enabled.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false
Determines whether this [Logger](../../../../logger-core/logger-core/com.chrynan.logger/-logger/index.md) instance should be used to output logs. The default value is up to the implementation and platform, but generally should be `false` to prevent accidental logging in a production environment. Explicitly set the value to be certain whether logging is enabled or not. | diff --git a/docs/logger-core/logger-core/com.chrynan.logger/-java-annotation-processor-messager-logger/is-enabled.md b/docs/logger-core/logger-core/com.chrynan.logger/-java-annotation-processor-messager-logger/is-enabled.md index 6a787ee..ce07a1b 100644 --- a/docs/logger-core/logger-core/com.chrynan.logger/-java-annotation-processor-messager-logger/is-enabled.md +++ b/docs/logger-core/logger-core/com.chrynan.logger/-java-annotation-processor-messager-logger/is-enabled.md @@ -3,8 +3,8 @@ # isEnabled [jvm]\ -open override var [isEnabled](is-enabled.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = true +open override var [isEnabled](is-enabled.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false -Determines whether this [Logger](../../../../logger-core/logger-core/com.chrynan.logger/-logger/index.md) instance should be used to output logs. This value should default to true. +Determines whether this [Logger](../../../../logger-core/logger-core/com.chrynan.logger/-logger/index.md) instance should be used to output logs. The default value is up to the implementation and platform, but generally should be `false` to prevent accidental logging in a production environment. Explicitly set the value to be certain whether logging is enabled or not. -**Note:** that it is up to the call-site to prevent logging if this value returns false. +**Note:** that it is up to the [Logger](../../../../logger-core/logger-core/com.chrynan.logger/-logger/index.md) implementation to prevent logging if this value returns `false`. diff --git a/docs/logger-core/logger-core/com.chrynan.logger/-java-annotation-processor-messager-logger/log.md b/docs/logger-core/logger-core/com.chrynan.logger/-java-annotation-processor-messager-logger/log.md index 2977a20..c9882e8 100644 --- a/docs/logger-core/logger-core/com.chrynan.logger/-java-annotation-processor-messager-logger/log.md +++ b/docs/logger-core/logger-core/com.chrynan.logger/-java-annotation-processor-messager-logger/log.md @@ -4,3 +4,5 @@ [jvm]\ open override fun [log](log.md)(logType: [LogType](../../../../logger-core/logger-core/com.chrynan.logger/-log-type/index.md), tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)?) + +Performs the action to log the provided details. diff --git a/docs/logger-core/logger-core/com.chrynan.logger/-java-logger/index.md b/docs/logger-core/logger-core/com.chrynan.logger/-java-logger/index.md index a1111a5..53927a2 100644 --- a/docs/logger-core/logger-core/com.chrynan.logger/-java-logger/index.md +++ b/docs/logger-core/logger-core/com.chrynan.logger/-java-logger/index.md @@ -5,21 +5,21 @@ [jvm]\ open class [JavaLogger](index.md)(logger: [Logger](https://developer.android.com/reference/kotlin/java/util/logging/Logger.html)) : [LogInitializer](../../../../logger-core/logger-core/com.chrynan.logger/-log-initializer/index.md), [Logger](../../../../logger-core/logger-core/com.chrynan.logger/-logger/index.md) +## Constructors + +| | | +|---|---| +| [JavaLogger](-java-logger.md) | [jvm]
fun [JavaLogger](-java-logger.md)(logger: [Logger](https://developer.android.com/reference/kotlin/java/util/logging/Logger.html)) | + ## Functions | Name | Summary | |---|---| -| [debug](index.md#528699424%2FFunctions%2F1038150354) | [jvm]
open fun [debug](index.md#528699424%2FFunctions%2F1038150354)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) | -| [error](index.md#-1522606379%2FFunctions%2F1038150354) | [jvm]
open fun [error](index.md#-1522606379%2FFunctions%2F1038150354)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) | -| [info](index.md#1308495187%2FFunctions%2F1038150354) | [jvm]
open fun [info](index.md#1308495187%2FFunctions%2F1038150354)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) | | [init](init.md) | [jvm]
open override fun [init](init.md)() | -| [log](log.md) | [jvm]
open override fun [log](log.md)(logType: [LogType](../../../../logger-core/logger-core/com.chrynan.logger/-log-type/index.md), tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)?) | -| [verbose](index.md#-736659633%2FFunctions%2F1038150354) | [jvm]
open fun [verbose](index.md#-736659633%2FFunctions%2F1038150354)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) | -| [warning](index.md#1679762281%2FFunctions%2F1038150354) | [jvm]
open fun [warning](index.md#1679762281%2FFunctions%2F1038150354)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) | -| [wtf](index.md#-1842084362%2FFunctions%2F1038150354) | [jvm]
open fun [wtf](index.md#-1842084362%2FFunctions%2F1038150354)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) | +| [log](log.md) | [jvm]
open override fun [log](log.md)(logType: [LogType](../../../../logger-core/logger-core/com.chrynan.logger/-log-type/index.md), tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)?)
Performs the action to log the provided details. | ## Properties | Name | Summary | |---|---| -| [isEnabled](is-enabled.md) | [jvm]
open override var [isEnabled](is-enabled.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = true
Determines whether this [Logger](https://developer.android.com/reference/kotlin/java/util/logging/Logger.html) instance should be used to output logs. This value should default to true. | +| [isEnabled](is-enabled.md) | [jvm]
open override var [isEnabled](is-enabled.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false
Determines whether this [Logger](https://developer.android.com/reference/kotlin/java/util/logging/Logger.html) instance should be used to output logs. The default value is up to the implementation and platform, but generally should be `false` to prevent accidental logging in a production environment. Explicitly set the value to be certain whether logging is enabled or not. | diff --git a/docs/logger-core/logger-core/com.chrynan.logger/-java-logger/is-enabled.md b/docs/logger-core/logger-core/com.chrynan.logger/-java-logger/is-enabled.md index 622bc0b..cc24e50 100644 --- a/docs/logger-core/logger-core/com.chrynan.logger/-java-logger/is-enabled.md +++ b/docs/logger-core/logger-core/com.chrynan.logger/-java-logger/is-enabled.md @@ -3,8 +3,8 @@ # isEnabled [jvm]\ -open override var [isEnabled](is-enabled.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = true +open override var [isEnabled](is-enabled.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false -Determines whether this [Logger](https://developer.android.com/reference/kotlin/java/util/logging/Logger.html) instance should be used to output logs. This value should default to true. +Determines whether this [Logger](https://developer.android.com/reference/kotlin/java/util/logging/Logger.html) instance should be used to output logs. The default value is up to the implementation and platform, but generally should be `false` to prevent accidental logging in a production environment. Explicitly set the value to be certain whether logging is enabled or not. -**Note:** that it is up to the call-site to prevent logging if this value returns false. +**Note:** that it is up to the [Logger](https://developer.android.com/reference/kotlin/java/util/logging/Logger.html) implementation to prevent logging if this value returns `false`. diff --git a/docs/logger-core/logger-core/com.chrynan.logger/-java-logger/log.md b/docs/logger-core/logger-core/com.chrynan.logger/-java-logger/log.md index 8b28e74..adf12c8 100644 --- a/docs/logger-core/logger-core/com.chrynan.logger/-java-logger/log.md +++ b/docs/logger-core/logger-core/com.chrynan.logger/-java-logger/log.md @@ -4,3 +4,5 @@ [jvm]\ open override fun [log](log.md)(logType: [LogType](../../../../logger-core/logger-core/com.chrynan.logger/-log-type/index.md), tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)?) + +Performs the action to log the provided details. diff --git a/docs/logger-core/logger-core/com.chrynan.logger/-log-cat-logger/index.md b/docs/logger-core/logger-core/com.chrynan.logger/-log-cat-logger/index.md index 28b0505..a028d9e 100644 --- a/docs/logger-core/logger-core/com.chrynan.logger/-log-cat-logger/index.md +++ b/docs/logger-core/logger-core/com.chrynan.logger/-log-cat-logger/index.md @@ -5,21 +5,21 @@ [android]\ open class [LogCatLogger](index.md) : [LogInitializer](../../../../logger-core/logger-core/com.chrynan.logger/-log-initializer/index.md), [Logger](../../../../logger-core/logger-core/com.chrynan.logger/-logger/index.md) +## Constructors + +| | | +|---|---| +| [LogCatLogger](-log-cat-logger.md) | [android]
fun [LogCatLogger](-log-cat-logger.md)() | + ## Functions | Name | Summary | |---|---| -| [debug](index.md#528699424%2FFunctions%2F-1911466570) | [android]
open fun [debug](index.md#528699424%2FFunctions%2F-1911466570)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) | -| [error](index.md#-1522606379%2FFunctions%2F-1911466570) | [android]
open fun [error](index.md#-1522606379%2FFunctions%2F-1911466570)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) | -| [info](index.md#1308495187%2FFunctions%2F-1911466570) | [android]
open fun [info](index.md#1308495187%2FFunctions%2F-1911466570)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) | | [init](init.md) | [android]
open override fun [init](init.md)() | -| [log](log.md) | [android]
open override fun [log](log.md)(logType: [LogType](../../../../logger-core/logger-core/com.chrynan.logger/-log-type/index.md), tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)?) | -| [verbose](index.md#-736659633%2FFunctions%2F-1911466570) | [android]
open fun [verbose](index.md#-736659633%2FFunctions%2F-1911466570)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) | -| [warning](index.md#1679762281%2FFunctions%2F-1911466570) | [android]
open fun [warning](index.md#1679762281%2FFunctions%2F-1911466570)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) | -| [wtf](index.md#-1842084362%2FFunctions%2F-1911466570) | [android]
open fun [wtf](index.md#-1842084362%2FFunctions%2F-1911466570)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) | +| [log](log.md) | [android]
open override fun [log](log.md)(logType: [LogType](../../../../logger-core/logger-core/com.chrynan.logger/-log-type/index.md), tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)?)
Performs the action to log the provided details. | ## Properties | Name | Summary | |---|---| -| [isEnabled](is-enabled.md) | [android]
open override var [isEnabled](is-enabled.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = true
Determines whether this [Logger](../../../../logger-core/logger-core/com.chrynan.logger/-logger/index.md) instance should be used to output logs. This value should default to true. | +| [isEnabled](is-enabled.md) | [android]
open override var [isEnabled](is-enabled.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Determines whether this [Logger](../../../../logger-core/logger-core/com.chrynan.logger/-logger/index.md) instance should be used to output logs. The default value is up to the implementation and platform, but generally should be `false` to prevent accidental logging in a production environment. Explicitly set the value to be certain whether logging is enabled or not. | diff --git a/docs/logger-core/logger-core/com.chrynan.logger/-log-cat-logger/is-enabled.md b/docs/logger-core/logger-core/com.chrynan.logger/-log-cat-logger/is-enabled.md index 915237e..f732348 100644 --- a/docs/logger-core/logger-core/com.chrynan.logger/-log-cat-logger/is-enabled.md +++ b/docs/logger-core/logger-core/com.chrynan.logger/-log-cat-logger/is-enabled.md @@ -3,8 +3,8 @@ # isEnabled [android]\ -open override var [isEnabled](is-enabled.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = true +open override var [isEnabled](is-enabled.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) -Determines whether this [Logger](../../../../logger-core/logger-core/com.chrynan.logger/-logger/index.md) instance should be used to output logs. This value should default to true. +Determines whether this [Logger](../../../../logger-core/logger-core/com.chrynan.logger/-logger/index.md) instance should be used to output logs. The default value is up to the implementation and platform, but generally should be `false` to prevent accidental logging in a production environment. Explicitly set the value to be certain whether logging is enabled or not. -**Note:** that it is up to the call-site to prevent logging if this value returns false. +**Note:** that it is up to the [Logger](../../../../logger-core/logger-core/com.chrynan.logger/-logger/index.md) implementation to prevent logging if this value returns `false`. diff --git a/docs/logger-core/logger-core/com.chrynan.logger/-log-cat-logger/log.md b/docs/logger-core/logger-core/com.chrynan.logger/-log-cat-logger/log.md index 04498f9..61d45fa 100644 --- a/docs/logger-core/logger-core/com.chrynan.logger/-log-cat-logger/log.md +++ b/docs/logger-core/logger-core/com.chrynan.logger/-log-cat-logger/log.md @@ -4,3 +4,5 @@ [android]\ open override fun [log](log.md)(logType: [LogType](../../../../logger-core/logger-core/com.chrynan.logger/-log-type/index.md), tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)?) + +Performs the action to log the provided details. diff --git a/docs/logger-core/logger-core/com.chrynan.logger/-log-initializer/index.md b/docs/logger-core/logger-core/com.chrynan.logger/-log-initializer/index.md index afc30f8..6233844 100644 --- a/docs/logger-core/logger-core/com.chrynan.logger/-log-initializer/index.md +++ b/docs/logger-core/logger-core/com.chrynan.logger/-log-initializer/index.md @@ -21,7 +21,7 @@ An interface that initializes an implementation of [Logger](../-logger/index.md) | [DelegatingLogger](../-delegating-logger/index.md) | | [Log](../-log/index.md) | | [NoActionLogger](../-no-action-logger/index.md) | -| [SimplePrintLineLogger](../-simple-print-line-logger/index.md) | +| [PrintLineLogger](../-print-line-logger/index.md) | | [NSLogger](../-n-s-logger/index.md) | | [ConsoleLogger](../-console-logger/index.md) | | [JavaAnnotationProcessorMessagerLogger](../-java-annotation-processor-messager-logger/index.md) | diff --git a/docs/logger-core/logger-core/com.chrynan.logger/-log-type/-d-e-b-u-g/index.md b/docs/logger-core/logger-core/com.chrynan.logger/-log-type/-d-e-b-u-g/index.md index f55a3cb..8ac67ea 100644 --- a/docs/logger-core/logger-core/com.chrynan.logger/-log-type/-d-e-b-u-g/index.md +++ b/docs/logger-core/logger-core/com.chrynan.logger/-log-type/-d-e-b-u-g/index.md @@ -3,12 +3,12 @@ # DEBUG [common]\ -[DEBUG](index.md)("Debug") +[DEBUG](index.md) ## Properties | Name | Summary | |---|---| -| [name](index.md#-372974862%2FProperties%2F532252580) | [common]
val [name](index.md#-372974862%2FProperties%2F532252580): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | -| [ordinal](index.md#-739389684%2FProperties%2F532252580) | [common]
val [ordinal](index.md#-739389684%2FProperties%2F532252580): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [name](../-e-r-r-o-r/index.md#-372974862%2FProperties%2F532252580) | [common]
val [name](../-e-r-r-o-r/index.md#-372974862%2FProperties%2F532252580): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../-e-r-r-o-r/index.md#-739389684%2FProperties%2F532252580) | [common]
val [ordinal](../-e-r-r-o-r/index.md#-739389684%2FProperties%2F532252580): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | | [typeName](../type-name.md) | [common]
val [typeName](../type-name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/logger-core/logger-core/com.chrynan.logger/-log-type/-e-r-r-o-r/index.md b/docs/logger-core/logger-core/com.chrynan.logger/-log-type/-e-r-r-o-r/index.md index 9834d18..ce84a81 100644 --- a/docs/logger-core/logger-core/com.chrynan.logger/-log-type/-e-r-r-o-r/index.md +++ b/docs/logger-core/logger-core/com.chrynan.logger/-log-type/-e-r-r-o-r/index.md @@ -3,12 +3,12 @@ # ERROR [common]\ -[ERROR](index.md)("Error") +[ERROR](index.md) ## Properties | Name | Summary | |---|---| -| [name](../-d-e-b-u-g/index.md#-372974862%2FProperties%2F532252580) | [common]
val [name](../-d-e-b-u-g/index.md#-372974862%2FProperties%2F532252580): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | -| [ordinal](../-d-e-b-u-g/index.md#-739389684%2FProperties%2F532252580) | [common]
val [ordinal](../-d-e-b-u-g/index.md#-739389684%2FProperties%2F532252580): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [name](index.md#-372974862%2FProperties%2F532252580) | [common]
val [name](index.md#-372974862%2FProperties%2F532252580): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](index.md#-739389684%2FProperties%2F532252580) | [common]
val [ordinal](index.md#-739389684%2FProperties%2F532252580): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | | [typeName](../type-name.md) | [common]
val [typeName](../type-name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/logger-core/logger-core/com.chrynan.logger/-log-type/-i-n-f-o/index.md b/docs/logger-core/logger-core/com.chrynan.logger/-log-type/-i-n-f-o/index.md index 998f8d1..fa963ab 100644 --- a/docs/logger-core/logger-core/com.chrynan.logger/-log-type/-i-n-f-o/index.md +++ b/docs/logger-core/logger-core/com.chrynan.logger/-log-type/-i-n-f-o/index.md @@ -3,12 +3,12 @@ # INFO [common]\ -[INFO](index.md)("Info") +[INFO](index.md) ## Properties | Name | Summary | |---|---| -| [name](../-d-e-b-u-g/index.md#-372974862%2FProperties%2F532252580) | [common]
val [name](../-d-e-b-u-g/index.md#-372974862%2FProperties%2F532252580): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | -| [ordinal](../-d-e-b-u-g/index.md#-739389684%2FProperties%2F532252580) | [common]
val [ordinal](../-d-e-b-u-g/index.md#-739389684%2FProperties%2F532252580): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [name](../-e-r-r-o-r/index.md#-372974862%2FProperties%2F532252580) | [common]
val [name](../-e-r-r-o-r/index.md#-372974862%2FProperties%2F532252580): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../-e-r-r-o-r/index.md#-739389684%2FProperties%2F532252580) | [common]
val [ordinal](../-e-r-r-o-r/index.md#-739389684%2FProperties%2F532252580): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | | [typeName](../type-name.md) | [common]
val [typeName](../type-name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/logger-core/logger-core/com.chrynan.logger/-log-type/-v-e-r-b-o-s-e/index.md b/docs/logger-core/logger-core/com.chrynan.logger/-log-type/-v-e-r-b-o-s-e/index.md index d5de35e..fc48789 100644 --- a/docs/logger-core/logger-core/com.chrynan.logger/-log-type/-v-e-r-b-o-s-e/index.md +++ b/docs/logger-core/logger-core/com.chrynan.logger/-log-type/-v-e-r-b-o-s-e/index.md @@ -3,12 +3,12 @@ # VERBOSE [common]\ -[VERBOSE](index.md)("Verbose") +[VERBOSE](index.md) ## Properties | Name | Summary | |---|---| -| [name](../-d-e-b-u-g/index.md#-372974862%2FProperties%2F532252580) | [common]
val [name](../-d-e-b-u-g/index.md#-372974862%2FProperties%2F532252580): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | -| [ordinal](../-d-e-b-u-g/index.md#-739389684%2FProperties%2F532252580) | [common]
val [ordinal](../-d-e-b-u-g/index.md#-739389684%2FProperties%2F532252580): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [name](../-e-r-r-o-r/index.md#-372974862%2FProperties%2F532252580) | [common]
val [name](../-e-r-r-o-r/index.md#-372974862%2FProperties%2F532252580): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../-e-r-r-o-r/index.md#-739389684%2FProperties%2F532252580) | [common]
val [ordinal](../-e-r-r-o-r/index.md#-739389684%2FProperties%2F532252580): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | | [typeName](../type-name.md) | [common]
val [typeName](../type-name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/logger-core/logger-core/com.chrynan.logger/-log-type/-w-a-r-n-i-n-g/index.md b/docs/logger-core/logger-core/com.chrynan.logger/-log-type/-w-a-r-n-i-n-g/index.md index 3cfbe54..5b0f0d8 100644 --- a/docs/logger-core/logger-core/com.chrynan.logger/-log-type/-w-a-r-n-i-n-g/index.md +++ b/docs/logger-core/logger-core/com.chrynan.logger/-log-type/-w-a-r-n-i-n-g/index.md @@ -3,12 +3,12 @@ # WARNING [common]\ -[WARNING](index.md)("Warning") +[WARNING](index.md) ## Properties | Name | Summary | |---|---| -| [name](../-d-e-b-u-g/index.md#-372974862%2FProperties%2F532252580) | [common]
val [name](../-d-e-b-u-g/index.md#-372974862%2FProperties%2F532252580): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | -| [ordinal](../-d-e-b-u-g/index.md#-739389684%2FProperties%2F532252580) | [common]
val [ordinal](../-d-e-b-u-g/index.md#-739389684%2FProperties%2F532252580): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [name](../-e-r-r-o-r/index.md#-372974862%2FProperties%2F532252580) | [common]
val [name](../-e-r-r-o-r/index.md#-372974862%2FProperties%2F532252580): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../-e-r-r-o-r/index.md#-739389684%2FProperties%2F532252580) | [common]
val [ordinal](../-e-r-r-o-r/index.md#-739389684%2FProperties%2F532252580): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | | [typeName](../type-name.md) | [common]
val [typeName](../type-name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/logger-core/logger-core/com.chrynan.logger/-log-type/-w-t-f/index.md b/docs/logger-core/logger-core/com.chrynan.logger/-log-type/-w-t-f/index.md index f097320..5fce214 100644 --- a/docs/logger-core/logger-core/com.chrynan.logger/-log-type/-w-t-f/index.md +++ b/docs/logger-core/logger-core/com.chrynan.logger/-log-type/-w-t-f/index.md @@ -3,12 +3,12 @@ # WTF [common]\ -[WTF](index.md)("Wtf") +[WTF](index.md) ## Properties | Name | Summary | |---|---| -| [name](../-d-e-b-u-g/index.md#-372974862%2FProperties%2F532252580) | [common]
val [name](../-d-e-b-u-g/index.md#-372974862%2FProperties%2F532252580): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | -| [ordinal](../-d-e-b-u-g/index.md#-739389684%2FProperties%2F532252580) | [common]
val [ordinal](../-d-e-b-u-g/index.md#-739389684%2FProperties%2F532252580): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [name](../-e-r-r-o-r/index.md#-372974862%2FProperties%2F532252580) | [common]
val [name](../-e-r-r-o-r/index.md#-372974862%2FProperties%2F532252580): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](../-e-r-r-o-r/index.md#-739389684%2FProperties%2F532252580) | [common]
val [ordinal](../-e-r-r-o-r/index.md#-739389684%2FProperties%2F532252580): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | | [typeName](../type-name.md) | [common]
val [typeName](../type-name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/logger-core/logger-core/com.chrynan.logger/-log-type/index.md b/docs/logger-core/logger-core/com.chrynan.logger/-log-type/index.md index afaa0dc..ecbdf9b 100644 --- a/docs/logger-core/logger-core/com.chrynan.logger/-log-type/index.md +++ b/docs/logger-core/logger-core/com.chrynan.logger/-log-type/index.md @@ -3,18 +3,20 @@ # LogType [common]\ -enum [LogType](index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[LogType](index.md)> +enum [LogType](index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[LogType](index.md)> + +Represents the type of log operation being performed. ## Entries | | | |---|---| -| [ERROR](-e-r-r-o-r/index.md) | [common]
[ERROR](-e-r-r-o-r/index.md)("Error") | -| [WTF](-w-t-f/index.md) | [common]
[WTF](-w-t-f/index.md)("Wtf") | -| [VERBOSE](-v-e-r-b-o-s-e/index.md) | [common]
[VERBOSE](-v-e-r-b-o-s-e/index.md)("Verbose") | -| [INFO](-i-n-f-o/index.md) | [common]
[INFO](-i-n-f-o/index.md)("Info") | -| [WARNING](-w-a-r-n-i-n-g/index.md) | [common]
[WARNING](-w-a-r-n-i-n-g/index.md)("Warning") | -| [DEBUG](-d-e-b-u-g/index.md) | [common]
[DEBUG](-d-e-b-u-g/index.md)("Debug") | +| [DEBUG](-d-e-b-u-g/index.md) | [common]
[DEBUG](-d-e-b-u-g/index.md) | +| [WARNING](-w-a-r-n-i-n-g/index.md) | [common]
[WARNING](-w-a-r-n-i-n-g/index.md) | +| [INFO](-i-n-f-o/index.md) | [common]
[INFO](-i-n-f-o/index.md) | +| [VERBOSE](-v-e-r-b-o-s-e/index.md) | [common]
[VERBOSE](-v-e-r-b-o-s-e/index.md) | +| [WTF](-w-t-f/index.md) | [common]
[WTF](-w-t-f/index.md) | +| [ERROR](-e-r-r-o-r/index.md) | [common]
[ERROR](-e-r-r-o-r/index.md) | ## Types @@ -26,6 +28,6 @@ enum [LogType](index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/k | Name | Summary | |---|---| -| [name](-d-e-b-u-g/index.md#-372974862%2FProperties%2F532252580) | [common]
val [name](-d-e-b-u-g/index.md#-372974862%2FProperties%2F532252580): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | -| [ordinal](-d-e-b-u-g/index.md#-739389684%2FProperties%2F532252580) | [common]
val [ordinal](-d-e-b-u-g/index.md#-739389684%2FProperties%2F532252580): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [name](-e-r-r-o-r/index.md#-372974862%2FProperties%2F532252580) | [common]
val [name](-e-r-r-o-r/index.md#-372974862%2FProperties%2F532252580): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](-e-r-r-o-r/index.md#-739389684%2FProperties%2F532252580) | [common]
val [ordinal](-e-r-r-o-r/index.md#-739389684%2FProperties%2F532252580): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | | [typeName](type-name.md) | [common]
val [typeName](type-name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/logger-core/logger-core/com.chrynan.logger/-log-values/index.md b/docs/logger-core/logger-core/com.chrynan.logger/-log-values/index.md index adfd7ae..4fb008f 100644 --- a/docs/logger-core/logger-core/com.chrynan.logger/-log-values/index.md +++ b/docs/logger-core/logger-core/com.chrynan.logger/-log-values/index.md @@ -3,7 +3,15 @@ # LogValues [common]\ -data class [LogValues](index.md)(logType: [LogType](../-log-type/index.md), tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)?) +data class [LogValues](index.md)(val logType: [LogType](../-log-type/index.md), val tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, val message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, val throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) + +Represents values required to invoke the [Logger.log](../-logger/log.md) function. + +## Constructors + +| | | +|---|---| +| [LogValues](-log-values.md) | [common]
fun [LogValues](-log-values.md)(logType: [LogType](../-log-type/index.md), tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) | ## Properties diff --git a/docs/logger-core/logger-core/com.chrynan.logger/-log/index.md b/docs/logger-core/logger-core/com.chrynan.logger/-log/index.md index 8a406a7..3f9a1f3 100644 --- a/docs/logger-core/logger-core/com.chrynan.logger/-log/index.md +++ b/docs/logger-core/logger-core/com.chrynan.logger/-log/index.md @@ -7,24 +7,17 @@ object [Log](index.md) : [Logger](../-logger/index.md), [LogInitializer](../-log An implementation of [Logger](../-logger/index.md) and [LogInitializer](../-log-initializer/index.md) that can be used as a singleton base to log throughout the application. Before calling one of [log](log.md) functions, a [Logger](../-logger/index.md) has to be assigned to the [logger](logger.md) property, this defaults to the [DefaultLogger](../-default-logger.md). Optionally, the [init](init.md) function can be called next, which just delegates to the [logger](logger.md) init function if it is a [LogInitializer](../-log-initializer/index.md) implementation. -Note: This object is annotated with [ThreadLocal](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.native.concurrent/-thread-local/index.html) which means that a new instance will be created for each Thread in Kotlin Native. - ## Functions | Name | Summary | |---|---| -| [debug](../-logger/debug.md) | [common]
open fun [debug](../-logger/debug.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) | -| [error](../-logger/error.md) | [common]
open fun [error](../-logger/error.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) | -| [info](../-logger/info.md) | [common]
open fun [info](../-logger/info.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) | | [init](init.md) | [common]
open override fun [init](init.md)() | -| [log](log.md) | [common]
open override fun [log](log.md)(logType: [LogType](../-log-type/index.md), tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)?) | -| [verbose](../-logger/verbose.md) | [common]
open fun [verbose](../-logger/verbose.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) | -| [warning](../-logger/warning.md) | [common]
open fun [warning](../-logger/warning.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) | -| [wtf](../-logger/wtf.md) | [common]
open fun [wtf](../-logger/wtf.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) | +| [log](log.md) | [common]
open override fun [log](log.md)(logType: [LogType](../-log-type/index.md), tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)?)
Performs the action to log the provided details. | ## Properties | Name | Summary | |---|---| -| [isEnabled](is-enabled.md) | [common]
open override var [isEnabled](is-enabled.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Determines whether this [Logger](../-logger/index.md) instance should be used to output logs. This value should default to true. | +| [isEnabled](is-enabled.md) | [common]
open override var [isEnabled](is-enabled.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Determines whether this [Logger](../-logger/index.md) instance should be used to output logs. The default value is up to the implementation and platform, but generally should be `false` to prevent accidental logging in a production environment. Explicitly set the value to be certain whether logging is enabled or not. | | [logger](logger.md) | [common]
var [logger](logger.md): [Logger](../-logger/index.md) | +| [logValues](log-values.md) | [common]
val [logValues](log-values.md): Flow<[LogValues](../-log-values/index.md)>
Retrieves a Flow of [LogValues](../-log-values/index.md) that are emitted after every successful invocation of the [log](log.md) on this [Log](index.md) object. | diff --git a/docs/logger-core/logger-core/com.chrynan.logger/-log/is-enabled.md b/docs/logger-core/logger-core/com.chrynan.logger/-log/is-enabled.md index 342331c..ddff3e9 100644 --- a/docs/logger-core/logger-core/com.chrynan.logger/-log/is-enabled.md +++ b/docs/logger-core/logger-core/com.chrynan.logger/-log/is-enabled.md @@ -5,6 +5,6 @@ [common]\ open override var [isEnabled](is-enabled.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) -Determines whether this [Logger](../-logger/index.md) instance should be used to output logs. This value should default to true. +Determines whether this [Logger](../-logger/index.md) instance should be used to output logs. The default value is up to the implementation and platform, but generally should be `false` to prevent accidental logging in a production environment. Explicitly set the value to be certain whether logging is enabled or not. -**Note:** that it is up to the call-site to prevent logging if this value returns false. +**Note:** that it is up to the [Logger](../-logger/index.md) implementation to prevent logging if this value returns `false`. diff --git a/docs/logger-core/logger-core/com.chrynan.logger/-log/log-values.md b/docs/logger-core/logger-core/com.chrynan.logger/-log/log-values.md new file mode 100644 index 0000000..34f1819 --- /dev/null +++ b/docs/logger-core/logger-core/com.chrynan.logger/-log/log-values.md @@ -0,0 +1,14 @@ +//[logger-core](../../../index.md)/[com.chrynan.logger](../index.md)/[Log](index.md)/[logValues](log-values.md) + +# logValues + +[common]\ +val [logValues](log-values.md): Flow<[LogValues](../-log-values/index.md)> + +Retrieves a Flow of [LogValues](../-log-values/index.md) that are emitted after every successful invocation of the [log](log.md) on this [Log](index.md) object. + +**Note:** If the [Log.isEnabled](is-enabled.md) property is `false` and the [Log.log](log.md) function is invoked, no [LogValues](../-log-values/index.md) will be emitted. + +**Note:**[LogValues](../-log-values/index.md) are emitted after the internal [Log.log](log.md) function is successfully invoked. + +**Note:** There is no guarantee that a value emitted from this Flow is actually logged, as it is up to the [Logger](../-logger/index.md) implementation set as the [Log.logger](logger.md) to decide how and whether to log. diff --git a/docs/logger-core/logger-core/com.chrynan.logger/-log/log.md b/docs/logger-core/logger-core/com.chrynan.logger/-log/log.md index d9a704c..20fb5a4 100644 --- a/docs/logger-core/logger-core/com.chrynan.logger/-log/log.md +++ b/docs/logger-core/logger-core/com.chrynan.logger/-log/log.md @@ -4,3 +4,5 @@ [common]\ open override fun [log](log.md)(logType: [LogType](../-log-type/index.md), tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)?) + +Performs the action to log the provided details. diff --git a/docs/logger-core/logger-core/com.chrynan.logger/-loggable/index.md b/docs/logger-core/logger-core/com.chrynan.logger/-loggable/index.md index fdb317e..1a0a3fe 100644 --- a/docs/logger-core/logger-core/com.chrynan.logger/-loggable/index.md +++ b/docs/logger-core/logger-core/com.chrynan.logger/-loggable/index.md @@ -3,12 +3,12 @@ # Loggable [common]\ -interface [Loggable](index.md) +fun interface [Loggable](index.md) Represents an object than can be logged with a [Logger](../-logger/index.md). -## Properties +## Functions | Name | Summary | |---|---| -| [logValues](log-values.md) | [common]
abstract val [logValues](log-values.md): [LogValues](../-log-values/index.md) | +| [logValues](log-values.md) | [common]
abstract fun [logValues](log-values.md)(): [LogValues](../-log-values/index.md)
Obtains the [LogValues](../-log-values/index.md) that can be used to invoke the [Logger.log](../-logger/log.md) function. | diff --git a/docs/logger-core/logger-core/com.chrynan.logger/-loggable/log-values.md b/docs/logger-core/logger-core/com.chrynan.logger/-loggable/log-values.md index 3b2d16a..1833d82 100644 --- a/docs/logger-core/logger-core/com.chrynan.logger/-loggable/log-values.md +++ b/docs/logger-core/logger-core/com.chrynan.logger/-loggable/log-values.md @@ -3,4 +3,6 @@ # logValues [common]\ -abstract val [logValues](log-values.md): [LogValues](../-log-values/index.md) +abstract fun [logValues](log-values.md)(): [LogValues](../-log-values/index.md) + +Obtains the [LogValues](../-log-values/index.md) that can be used to invoke the [Logger.log](../-logger/log.md) function. diff --git a/docs/logger-core/logger-core/com.chrynan.logger/-logger/index.md b/docs/logger-core/logger-core/com.chrynan.logger/-logger/index.md index 371fdfa..2adb79d 100644 --- a/docs/logger-core/logger-core/com.chrynan.logger/-logger/index.md +++ b/docs/logger-core/logger-core/com.chrynan.logger/-logger/index.md @@ -11,29 +11,24 @@ A platform-agnostic Kotlin Multiplatform Logging interface inspired by Android's | Name | Summary | |---|---| -| [debug](debug.md) | [common]
open fun [debug](debug.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) | -| [error](error.md) | [common]
open fun [error](error.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) | -| [info](info.md) | [common]
open fun [info](info.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) | -| [log](log.md) | [common]
abstract fun [log](log.md)(logType: [LogType](../-log-type/index.md), tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) | -| [verbose](verbose.md) | [common]
open fun [verbose](verbose.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) | -| [warning](warning.md) | [common]
open fun [warning](warning.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) | -| [wtf](wtf.md) | [common]
open fun [wtf](wtf.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) | +| [log](log.md) | [common]
abstract fun [log](log.md)(logType: [LogType](../-log-type/index.md), tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null)
Performs the action to log the provided details. | ## Properties | Name | Summary | |---|---| -| [isEnabled](is-enabled.md) | [common]
abstract var [isEnabled](is-enabled.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Determines whether this [Logger](index.md) instance should be used to output logs. This value should default to true. | +| [isEnabled](is-enabled.md) | [common]
abstract var [isEnabled](is-enabled.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Determines whether this [Logger](index.md) instance should be used to output logs. The default value is up to the implementation and platform, but generally should be `false` to prevent accidental logging in a production environment. Explicitly set the value to be certain whether logging is enabled or not. | ## Inheritors | Name | |---| | [LogCatLogger](../-log-cat-logger/index.md) | +| [AsyncLogger](../-async-logger/index.md) | | [DelegatingLogger](../-delegating-logger/index.md) | | [Log](../-log/index.md) | | [NoActionLogger](../-no-action-logger/index.md) | -| [SimplePrintLineLogger](../-simple-print-line-logger/index.md) | +| [PrintLineLogger](../-print-line-logger/index.md) | | [NSLogger](../-n-s-logger/index.md) | | [ConsoleLogger](../-console-logger/index.md) | | [JavaAnnotationProcessorMessagerLogger](../-java-annotation-processor-messager-logger/index.md) | @@ -43,4 +38,10 @@ A platform-agnostic Kotlin Multiplatform Logging interface inspired by Android's | Name | Summary | |---|---| -| [log](../log.md) | [common]
fun [Logger](index.md).[log](../log.md)(logValues: [LogValues](../-log-values/index.md))
fun [Logger](index.md).[log](../log.md)(loggable: [Loggable](../-loggable/index.md)) | +| [debug](../debug.md) | [common]
inline fun [Logger](index.md).[debug](../debug.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null)
inline fun [Logger](index.md).[debug](../debug.md)(tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null, messageBuilder: () -> [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?)
Invokes the [Logger.log](log.md) function for [LogType.DEBUG](../-log-type/-d-e-b-u-g/index.md). | +| [error](../error.md) | [common]
inline fun [Logger](index.md).[error](../error.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null)
inline fun [Logger](index.md).[error](../error.md)(tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null, messageBuilder: () -> [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?)
Invokes the [Logger.log](log.md) function for [LogType.ERROR](../-log-type/-e-r-r-o-r/index.md). | +| [info](../info.md) | [common]
inline fun [Logger](index.md).[info](../info.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null)
inline fun [Logger](index.md).[info](../info.md)(tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null, messageBuilder: () -> [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?)
Invokes the [Logger.log](log.md) function for [LogType.INFO](../-log-type/-i-n-f-o/index.md). | +| [log](../log.md) | [common]
inline fun [Logger](index.md).[log](../log.md)(logValues: [LogValues](../-log-values/index.md))
Invokes the [Logger.log](log.md) function using the provided [logValues](../log.md).
[common]
inline fun [Logger](index.md).[log](../log.md)(loggable: [Loggable](../-loggable/index.md))
Invokes the [Logger.log](log.md) function using the [Loggable.logValues](../-loggable/log-values.md) obtained from the provided [loggable](../log.md) instance. | +| [verbose](../verbose.md) | [common]
inline fun [Logger](index.md).[verbose](../verbose.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null)
inline fun [Logger](index.md).[verbose](../verbose.md)(tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null, messageBuilder: () -> [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?)
Invokes the [Logger.log](log.md) function for [LogType.VERBOSE](../-log-type/-v-e-r-b-o-s-e/index.md). | +| [warning](../warning.md) | [common]
inline fun [Logger](index.md).[warning](../warning.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null)
inline fun [Logger](index.md).[warning](../warning.md)(tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null, messageBuilder: () -> [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?)
Invokes the [Logger.log](log.md) function for [LogType.WARNING](../-log-type/-w-a-r-n-i-n-g/index.md). | +| [wtf](../wtf.md) | [common]
inline fun [Logger](index.md).[wtf](../wtf.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null)
inline fun [Logger](index.md).[wtf](../wtf.md)(tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null, messageBuilder: () -> [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?)
Invokes the [Logger.log](log.md) function for [LogType.WTF](../-log-type/-w-t-f/index.md). | diff --git a/docs/logger-core/logger-core/com.chrynan.logger/-logger/is-enabled.md b/docs/logger-core/logger-core/com.chrynan.logger/-logger/is-enabled.md index 5578290..987c0f3 100644 --- a/docs/logger-core/logger-core/com.chrynan.logger/-logger/is-enabled.md +++ b/docs/logger-core/logger-core/com.chrynan.logger/-logger/is-enabled.md @@ -5,6 +5,6 @@ [common]\ abstract var [isEnabled](is-enabled.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) -Determines whether this [Logger](index.md) instance should be used to output logs. This value should default to true. +Determines whether this [Logger](index.md) instance should be used to output logs. The default value is up to the implementation and platform, but generally should be `false` to prevent accidental logging in a production environment. Explicitly set the value to be certain whether logging is enabled or not. -**Note:** that it is up to the call-site to prevent logging if this value returns false. +**Note:** that it is up to the [Logger](index.md) implementation to prevent logging if this value returns `false`. diff --git a/docs/logger-core/logger-core/com.chrynan.logger/-logger/log.md b/docs/logger-core/logger-core/com.chrynan.logger/-logger/log.md index f951168..beea1ac 100644 --- a/docs/logger-core/logger-core/com.chrynan.logger/-logger/log.md +++ b/docs/logger-core/logger-core/com.chrynan.logger/-logger/log.md @@ -4,3 +4,5 @@ [common]\ abstract fun [log](log.md)(logType: [LogType](../-log-type/index.md), tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) + +Performs the action to log the provided details. diff --git a/docs/logger-core/logger-core/com.chrynan.logger/-n-s-logger/index.md b/docs/logger-core/logger-core/com.chrynan.logger/-n-s-logger/index.md index d7cf264..85869c2 100644 --- a/docs/logger-core/logger-core/com.chrynan.logger/-n-s-logger/index.md +++ b/docs/logger-core/logger-core/com.chrynan.logger/-n-s-logger/index.md @@ -5,21 +5,21 @@ [ios]\ open class [NSLogger](index.md) : [Logger](../../../../logger-core/logger-core/com.chrynan.logger/-logger/index.md), [LogInitializer](../../../../logger-core/logger-core/com.chrynan.logger/-log-initializer/index.md) +## Constructors + +| | | +|---|---| +| [NSLogger](-n-s-logger.md) | [ios]
fun [NSLogger](-n-s-logger.md)() | + ## Functions | Name | Summary | |---|---| -| [debug](index.md#528699424%2FFunctions%2F684560480) | [ios]
open fun [debug](index.md#528699424%2FFunctions%2F684560480)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) | -| [error](index.md#-1522606379%2FFunctions%2F684560480) | [ios]
open fun [error](index.md#-1522606379%2FFunctions%2F684560480)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) | -| [info](index.md#1308495187%2FFunctions%2F684560480) | [ios]
open fun [info](index.md#1308495187%2FFunctions%2F684560480)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) | | [init](init.md) | [ios]
open override fun [init](init.md)() | -| [log](log.md) | [ios]
open override fun [log](log.md)(logType: [LogType](../../../../logger-core/logger-core/com.chrynan.logger/-log-type/index.md), tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)?) | -| [verbose](index.md#-736659633%2FFunctions%2F684560480) | [ios]
open fun [verbose](index.md#-736659633%2FFunctions%2F684560480)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) | -| [warning](index.md#1679762281%2FFunctions%2F684560480) | [ios]
open fun [warning](index.md#1679762281%2FFunctions%2F684560480)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) | -| [wtf](index.md#-1842084362%2FFunctions%2F684560480) | [ios]
open fun [wtf](index.md#-1842084362%2FFunctions%2F684560480)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) | +| [log](log.md) | [ios]
open override fun [log](log.md)(logType: [LogType](../../../../logger-core/logger-core/com.chrynan.logger/-log-type/index.md), tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)?)
Performs the action to log the provided details. | ## Properties | Name | Summary | |---|---| -| [isEnabled](is-enabled.md) | [ios]
open override var [isEnabled](is-enabled.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = true
Determines whether this [Logger](../../../../logger-core/logger-core/com.chrynan.logger/-logger/index.md) instance should be used to output logs. This value should default to true. | +| [isEnabled](is-enabled.md) | [ios]
open override var [isEnabled](is-enabled.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false
Determines whether this [Logger](../../../../logger-core/logger-core/com.chrynan.logger/-logger/index.md) instance should be used to output logs. The default value is up to the implementation and platform, but generally should be `false` to prevent accidental logging in a production environment. Explicitly set the value to be certain whether logging is enabled or not. | diff --git a/docs/logger-core/logger-core/com.chrynan.logger/-n-s-logger/is-enabled.md b/docs/logger-core/logger-core/com.chrynan.logger/-n-s-logger/is-enabled.md index 42ca426..52f38d4 100644 --- a/docs/logger-core/logger-core/com.chrynan.logger/-n-s-logger/is-enabled.md +++ b/docs/logger-core/logger-core/com.chrynan.logger/-n-s-logger/is-enabled.md @@ -3,8 +3,8 @@ # isEnabled [ios]\ -open override var [isEnabled](is-enabled.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = true +open override var [isEnabled](is-enabled.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false -Determines whether this [Logger](../../../../logger-core/logger-core/com.chrynan.logger/-logger/index.md) instance should be used to output logs. This value should default to true. +Determines whether this [Logger](../../../../logger-core/logger-core/com.chrynan.logger/-logger/index.md) instance should be used to output logs. The default value is up to the implementation and platform, but generally should be `false` to prevent accidental logging in a production environment. Explicitly set the value to be certain whether logging is enabled or not. -**Note:** that it is up to the call-site to prevent logging if this value returns false. +**Note:** that it is up to the [Logger](../../../../logger-core/logger-core/com.chrynan.logger/-logger/index.md) implementation to prevent logging if this value returns `false`. diff --git a/docs/logger-core/logger-core/com.chrynan.logger/-n-s-logger/log.md b/docs/logger-core/logger-core/com.chrynan.logger/-n-s-logger/log.md index fbe8504..dd2d5e9 100644 --- a/docs/logger-core/logger-core/com.chrynan.logger/-n-s-logger/log.md +++ b/docs/logger-core/logger-core/com.chrynan.logger/-n-s-logger/log.md @@ -4,3 +4,5 @@ [ios]\ open override fun [log](log.md)(logType: [LogType](../../../../logger-core/logger-core/com.chrynan.logger/-log-type/index.md), tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)?) + +Performs the action to log the provided details. diff --git a/docs/logger-core/logger-core/com.chrynan.logger/-no-action-logger/index.md b/docs/logger-core/logger-core/com.chrynan.logger/-no-action-logger/index.md index e52951d..41be6cb 100644 --- a/docs/logger-core/logger-core/com.chrynan.logger/-no-action-logger/index.md +++ b/docs/logger-core/logger-core/com.chrynan.logger/-no-action-logger/index.md @@ -17,17 +17,11 @@ A simple implementation of [Logger](../-logger/index.md) that performs no action | Name | Summary | |---|---| -| [debug](../-logger/debug.md) | [common]
open fun [debug](../-logger/debug.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) | -| [error](../-logger/error.md) | [common]
open fun [error](../-logger/error.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) | -| [info](../-logger/info.md) | [common]
open fun [info](../-logger/info.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) | | [init](init.md) | [common]
open override fun [init](init.md)() | -| [log](log.md) | [common]
open override fun [log](log.md)(logType: [LogType](../-log-type/index.md), tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)?) | -| [verbose](../-logger/verbose.md) | [common]
open fun [verbose](../-logger/verbose.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) | -| [warning](../-logger/warning.md) | [common]
open fun [warning](../-logger/warning.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) | -| [wtf](../-logger/wtf.md) | [common]
open fun [wtf](../-logger/wtf.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) | +| [log](log.md) | [common]
open override fun [log](log.md)(logType: [LogType](../-log-type/index.md), tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)?)
Performs the action to log the provided details. | ## Properties | Name | Summary | |---|---| -| [isEnabled](is-enabled.md) | [common]
open override var [isEnabled](is-enabled.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = true
Determines whether this [Logger](../-logger/index.md) instance should be used to output logs. This value should default to true. | +| [isEnabled](is-enabled.md) | [common]
open override var [isEnabled](is-enabled.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false
Determines whether this [Logger](../-logger/index.md) instance should be used to output logs. The default value is up to the implementation and platform, but generally should be `false` to prevent accidental logging in a production environment. Explicitly set the value to be certain whether logging is enabled or not. | diff --git a/docs/logger-core/logger-core/com.chrynan.logger/-no-action-logger/is-enabled.md b/docs/logger-core/logger-core/com.chrynan.logger/-no-action-logger/is-enabled.md index 01de5b2..3691173 100644 --- a/docs/logger-core/logger-core/com.chrynan.logger/-no-action-logger/is-enabled.md +++ b/docs/logger-core/logger-core/com.chrynan.logger/-no-action-logger/is-enabled.md @@ -3,8 +3,8 @@ # isEnabled [common]\ -open override var [isEnabled](is-enabled.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = true +open override var [isEnabled](is-enabled.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false -Determines whether this [Logger](../-logger/index.md) instance should be used to output logs. This value should default to true. +Determines whether this [Logger](../-logger/index.md) instance should be used to output logs. The default value is up to the implementation and platform, but generally should be `false` to prevent accidental logging in a production environment. Explicitly set the value to be certain whether logging is enabled or not. -**Note:** that it is up to the call-site to prevent logging if this value returns false. +**Note:** that it is up to the [Logger](../-logger/index.md) implementation to prevent logging if this value returns `false`. diff --git a/docs/logger-core/logger-core/com.chrynan.logger/-no-action-logger/log.md b/docs/logger-core/logger-core/com.chrynan.logger/-no-action-logger/log.md index 85b01c5..0ee3bc8 100644 --- a/docs/logger-core/logger-core/com.chrynan.logger/-no-action-logger/log.md +++ b/docs/logger-core/logger-core/com.chrynan.logger/-no-action-logger/log.md @@ -4,3 +4,5 @@ [common]\ open override fun [log](log.md)(logType: [LogType](../-log-type/index.md), tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)?) + +Performs the action to log the provided details. diff --git a/docs/logger-core/logger-core/com.chrynan.logger/-print-line-logger/-companion/index.md b/docs/logger-core/logger-core/com.chrynan.logger/-print-line-logger/-companion/index.md new file mode 100644 index 0000000..aa99b38 --- /dev/null +++ b/docs/logger-core/logger-core/com.chrynan.logger/-print-line-logger/-companion/index.md @@ -0,0 +1,6 @@ +//[logger-core](../../../../index.md)/[com.chrynan.logger](../../index.md)/[PrintLineLogger](../index.md)/[Companion](index.md) + +# Companion + +[common]\ +object [Companion](index.md) diff --git a/docs/logger-core/logger-core/com.chrynan.logger/-print-line-logger/-print-line-logger.md b/docs/logger-core/logger-core/com.chrynan.logger/-print-line-logger/-print-line-logger.md new file mode 100644 index 0000000..9565ea2 --- /dev/null +++ b/docs/logger-core/logger-core/com.chrynan.logger/-print-line-logger/-print-line-logger.md @@ -0,0 +1,6 @@ +//[logger-core](../../../index.md)/[com.chrynan.logger](../index.md)/[PrintLineLogger](index.md)/[PrintLineLogger](-print-line-logger.md) + +# PrintLineLogger + +[common]\ +fun [PrintLineLogger](-print-line-logger.md)() diff --git a/docs/logger-core/logger-core/com.chrynan.logger/-print-line-logger/index.md b/docs/logger-core/logger-core/com.chrynan.logger/-print-line-logger/index.md new file mode 100644 index 0000000..d17ab64 --- /dev/null +++ b/docs/logger-core/logger-core/com.chrynan.logger/-print-line-logger/index.md @@ -0,0 +1,33 @@ +//[logger-core](../../../index.md)/[com.chrynan.logger](../index.md)/[PrintLineLogger](index.md) + +# PrintLineLogger + +[common]\ +open class [PrintLineLogger](index.md) : [LogInitializer](../-log-initializer/index.md), [Logger](../-logger/index.md) + +A simple implementation of [Logger](../-logger/index.md) that calls [println](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.io/index.html) when a log function is called. + +## Constructors + +| | | +|---|---| +| [PrintLineLogger](-print-line-logger.md) | [common]
fun [PrintLineLogger](-print-line-logger.md)() | + +## Types + +| Name | Summary | +|---|---| +| [Companion](-companion/index.md) | [common]
object [Companion](-companion/index.md) | + +## Functions + +| Name | Summary | +|---|---| +| [init](init.md) | [common]
open override fun [init](init.md)() | +| [log](log.md) | [common]
open override fun [log](log.md)(logType: [LogType](../-log-type/index.md), tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)?)
Performs the action to log the provided details. | + +## Properties + +| Name | Summary | +|---|---| +| [isEnabled](is-enabled.md) | [common]
open override var [isEnabled](is-enabled.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false
Determines whether this [Logger](../-logger/index.md) instance should be used to output logs. The default value is up to the implementation and platform, but generally should be `false` to prevent accidental logging in a production environment. Explicitly set the value to be certain whether logging is enabled or not. | diff --git a/docs/logger-core/logger-core/com.chrynan.logger/-print-line-logger/init.md b/docs/logger-core/logger-core/com.chrynan.logger/-print-line-logger/init.md new file mode 100644 index 0000000..af6e9d2 --- /dev/null +++ b/docs/logger-core/logger-core/com.chrynan.logger/-print-line-logger/init.md @@ -0,0 +1,6 @@ +//[logger-core](../../../index.md)/[com.chrynan.logger](../index.md)/[PrintLineLogger](index.md)/[init](init.md) + +# init + +[common]\ +open override fun [init](init.md)() diff --git a/docs/logger-core/logger-core/com.chrynan.logger/-print-line-logger/is-enabled.md b/docs/logger-core/logger-core/com.chrynan.logger/-print-line-logger/is-enabled.md new file mode 100644 index 0000000..a2deeb9 --- /dev/null +++ b/docs/logger-core/logger-core/com.chrynan.logger/-print-line-logger/is-enabled.md @@ -0,0 +1,10 @@ +//[logger-core](../../../index.md)/[com.chrynan.logger](../index.md)/[PrintLineLogger](index.md)/[isEnabled](is-enabled.md) + +# isEnabled + +[common]\ +open override var [isEnabled](is-enabled.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false + +Determines whether this [Logger](../-logger/index.md) instance should be used to output logs. The default value is up to the implementation and platform, but generally should be `false` to prevent accidental logging in a production environment. Explicitly set the value to be certain whether logging is enabled or not. + +**Note:** that it is up to the [Logger](../-logger/index.md) implementation to prevent logging if this value returns `false`. diff --git a/docs/logger-core/logger-core/com.chrynan.logger/-print-line-logger/log.md b/docs/logger-core/logger-core/com.chrynan.logger/-print-line-logger/log.md new file mode 100644 index 0000000..b5d3441 --- /dev/null +++ b/docs/logger-core/logger-core/com.chrynan.logger/-print-line-logger/log.md @@ -0,0 +1,8 @@ +//[logger-core](../../../index.md)/[com.chrynan.logger](../index.md)/[PrintLineLogger](index.md)/[log](log.md) + +# log + +[common]\ +open override fun [log](log.md)(logType: [LogType](../-log-type/index.md), tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)?) + +Performs the action to log the provided details. diff --git a/docs/logger-core/logger-core/com.chrynan.logger/debug.md b/docs/logger-core/logger-core/com.chrynan.logger/debug.md new file mode 100644 index 0000000..9595a6c --- /dev/null +++ b/docs/logger-core/logger-core/com.chrynan.logger/debug.md @@ -0,0 +1,10 @@ +//[logger-core](../../index.md)/[com.chrynan.logger](index.md)/[debug](debug.md) + +# debug + +[common]\ +inline fun [Logger](-logger/index.md).[debug](debug.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) + +inline fun [Logger](-logger/index.md).[debug](debug.md)(tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null, messageBuilder: () -> [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?) + +Invokes the [Logger.log](-logger/log.md) function for [LogType.DEBUG](-log-type/-d-e-b-u-g/index.md). diff --git a/docs/logger-core/logger-core/com.chrynan.logger/error.md b/docs/logger-core/logger-core/com.chrynan.logger/error.md new file mode 100644 index 0000000..b65746f --- /dev/null +++ b/docs/logger-core/logger-core/com.chrynan.logger/error.md @@ -0,0 +1,10 @@ +//[logger-core](../../index.md)/[com.chrynan.logger](index.md)/[error](error.md) + +# error + +[common]\ +inline fun [Logger](-logger/index.md).[error](error.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) + +inline fun [Logger](-logger/index.md).[error](error.md)(tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null, messageBuilder: () -> [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?) + +Invokes the [Logger.log](-logger/log.md) function for [LogType.ERROR](-log-type/-e-r-r-o-r/index.md). diff --git a/docs/logger-core/logger-core/com.chrynan.logger/index.md b/docs/logger-core/logger-core/com.chrynan.logger/index.md index 5a5c2d0..492e00e 100644 --- a/docs/logger-core/logger-core/com.chrynan.logger/index.md +++ b/docs/logger-core/logger-core/com.chrynan.logger/index.md @@ -7,25 +7,32 @@ | Name | Summary | |---|---| | [AndroidLogger](index.md#-591647867%2FClasslikes%2F-1911466570) | [android]
typealias [AndroidLogger](index.md#-591647867%2FClasslikes%2F-1911466570) = [LogCatLogger](-log-cat-logger/index.md) | +| [AsyncLogger](-async-logger/index.md) | [common]
abstract class [AsyncLogger](-async-logger/index.md) : [Logger](-logger/index.md)
An abstract class implementation of the [Logger](-logger/index.md) interface allowing for use of kotlin coroutines and suspend functions. This effectively allows for asynchronous logging of messages. | | [ConsoleLogger](-console-logger/index.md) | [js]
open class [ConsoleLogger](-console-logger/index.md) : [LogInitializer](../../../logger-core/logger-core/com.chrynan.logger/-log-initializer/index.md), [Logger](../../../logger-core/logger-core/com.chrynan.logger/-logger/index.md) | -| [DelegatingLogger](-delegating-logger/index.md) | [common]
class [DelegatingLogger](-delegating-logger/index.md)(loggers: [Set](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html)<[Logger](-logger/index.md)>, delegateIsEnabledChanges: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) : [Logger](-logger/index.md), [LogInitializer](-log-initializer/index.md)
A [Logger](-logger/index.md) implementation that delegates to the provided [loggers](../../../logger-core/com.chrynan.logger/-delegating-logger/loggers.md). This allows for using multiple [Logger](-logger/index.md)s. | +| [DelegatingLogger](-delegating-logger/index.md) | [common]
class [DelegatingLogger](-delegating-logger/index.md)(loggers: [Set](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html)<[Logger](-logger/index.md)>, delegateIsEnabledChanges: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false) : [Logger](-logger/index.md), [LogInitializer](-log-initializer/index.md)
A [Logger](-logger/index.md) implementation that delegates to the provided [loggers](../../../logger-core/com.chrynan.logger/-delegating-logger/loggers.md). This allows for using multiple [Logger](-logger/index.md)s. | | [JavaAnnotationProcessorMessagerLogger](-java-annotation-processor-messager-logger/index.md) | [jvm]
open class [JavaAnnotationProcessorMessagerLogger](-java-annotation-processor-messager-logger/index.md)(messager: [Messager](https://docs.oracle.com/javase/8/docs/api/javax/annotation/processing/Messager.html)) : [Logger](../../../logger-core/logger-core/com.chrynan.logger/-logger/index.md), [LogInitializer](../../../logger-core/logger-core/com.chrynan.logger/-log-initializer/index.md) | | [JavaLogger](-java-logger/index.md) | [jvm]
open class [JavaLogger](-java-logger/index.md)(logger: [Logger](https://developer.android.com/reference/kotlin/java/util/logging/Logger.html)) : [LogInitializer](../../../logger-core/logger-core/com.chrynan.logger/-log-initializer/index.md), [Logger](../../../logger-core/logger-core/com.chrynan.logger/-logger/index.md) | | [JavaMessageLogger](index.md#1831123503%2FClasslikes%2F1038150354) | [jvm]
typealias [JavaMessageLogger](index.md#1831123503%2FClasslikes%2F1038150354) = [JavaAnnotationProcessorMessagerLogger](-java-annotation-processor-messager-logger/index.md) | | [Log](-log/index.md) | [common]
object [Log](-log/index.md) : [Logger](-logger/index.md), [LogInitializer](-log-initializer/index.md)
An implementation of [Logger](-logger/index.md) and [LogInitializer](-log-initializer/index.md) that can be used as a singleton base to log throughout the application. Before calling one of [log](-log/log.md) functions, a [Logger](-logger/index.md) has to be assigned to the [logger](-log/logger.md) property, this defaults to the [DefaultLogger](-default-logger.md). Optionally, the [init](-log/init.md) function can be called next, which just delegates to the [logger](-log/logger.md) init function if it is a [LogInitializer](-log-initializer/index.md) implementation. | | [LogCatLogger](-log-cat-logger/index.md) | [android]
open class [LogCatLogger](-log-cat-logger/index.md) : [LogInitializer](../../../logger-core/logger-core/com.chrynan.logger/-log-initializer/index.md), [Logger](../../../logger-core/logger-core/com.chrynan.logger/-logger/index.md) | -| [Loggable](-loggable/index.md) | [common]
interface [Loggable](-loggable/index.md)
Represents an object than can be logged with a [Logger](-logger/index.md). | +| [Loggable](-loggable/index.md) | [common]
fun interface [Loggable](-loggable/index.md)
Represents an object than can be logged with a [Logger](-logger/index.md). | | [Logger](-logger/index.md) | [common]
interface [Logger](-logger/index.md)
A platform-agnostic Kotlin Multiplatform Logging interface inspired by Android's Log class. | | [LogInitializer](-log-initializer/index.md) | [common]
interface [LogInitializer](-log-initializer/index.md)
An interface that initializes an implementation of [Logger](-logger/index.md). | -| [LogType](-log-type/index.md) | [common]
enum [LogType](-log-type/index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[LogType](-log-type/index.md)> | -| [LogValues](-log-values/index.md) | [common]
data class [LogValues](-log-values/index.md)(logType: [LogType](-log-type/index.md), tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)?) | +| [LogType](-log-type/index.md) | [common]
enum [LogType](-log-type/index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[LogType](-log-type/index.md)>
Represents the type of log operation being performed. | +| [LogValues](-log-values/index.md) | [common]
data class [LogValues](-log-values/index.md)(val logType: [LogType](-log-type/index.md), val tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, val message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, val throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null)
Represents values required to invoke the [Logger.log](-logger/log.md) function. | | [NoActionLogger](-no-action-logger/index.md) | [common]
open class [NoActionLogger](-no-action-logger/index.md) : [LogInitializer](-log-initializer/index.md), [Logger](-logger/index.md)
A simple implementation of [Logger](-logger/index.md) that performs no action and prints no log when a function is called. This class could be useful to extend if only some functions have to be overridden. | | [NSLogger](-n-s-logger/index.md) | [ios]
open class [NSLogger](-n-s-logger/index.md) : [Logger](../../../logger-core/logger-core/com.chrynan.logger/-logger/index.md), [LogInitializer](../../../logger-core/logger-core/com.chrynan.logger/-log-initializer/index.md) | -| [SimplePrintLineLogger](-simple-print-line-logger/index.md) | [common]
open class [SimplePrintLineLogger](-simple-print-line-logger/index.md) : [LogInitializer](-log-initializer/index.md), [Logger](-logger/index.md)
A simple implementation of [Logger](-logger/index.md) that calls [println](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.io/index.html) when a log function is called. | +| [PrintLineLogger](-print-line-logger/index.md) | [common]
open class [PrintLineLogger](-print-line-logger/index.md) : [LogInitializer](-log-initializer/index.md), [Logger](-logger/index.md)
A simple implementation of [Logger](-logger/index.md) that calls [println](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.io/index.html) when a log function is called. | ## Functions | Name | Summary | |---|---| +| [debug](debug.md) | [common]
inline fun [Logger](-logger/index.md).[debug](debug.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null)
inline fun [Logger](-logger/index.md).[debug](debug.md)(tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null, messageBuilder: () -> [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?)
Invokes the [Logger.log](-logger/log.md) function for [LogType.DEBUG](-log-type/-d-e-b-u-g/index.md). | | [DefaultLogger](-default-logger.md) | [common, android, ios, js, jvm]
[common]
expect fun [DefaultLogger](-default-logger.md)(): [Logger](-logger/index.md)
[android, ios, js, jvm]
actual fun [DefaultLogger](-default-logger.md)(): [Logger](../../../logger-core/logger-core/com.chrynan.logger/-logger/index.md) | -| [log](log.md) | [common]
fun [Logger](-logger/index.md).[log](log.md)(logValues: [LogValues](-log-values/index.md))
fun [Logger](-logger/index.md).[log](log.md)(loggable: [Loggable](-loggable/index.md)) | +| [error](error.md) | [common]
inline fun [Logger](-logger/index.md).[error](error.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null)
inline fun [Logger](-logger/index.md).[error](error.md)(tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null, messageBuilder: () -> [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?)
Invokes the [Logger.log](-logger/log.md) function for [LogType.ERROR](-log-type/-e-r-r-o-r/index.md). | +| [info](info.md) | [common]
inline fun [Logger](-logger/index.md).[info](info.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null)
inline fun [Logger](-logger/index.md).[info](info.md)(tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null, messageBuilder: () -> [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?)
Invokes the [Logger.log](-logger/log.md) function for [LogType.INFO](-log-type/-i-n-f-o/index.md). | +| [log](log.md) | [common]
inline fun [Logger](-logger/index.md).[log](log.md)(logValues: [LogValues](-log-values/index.md))
Invokes the [Logger.log](-logger/log.md) function using the provided [logValues](log.md).
[common]
inline fun [Logger](-logger/index.md).[log](log.md)(loggable: [Loggable](-loggable/index.md))
Invokes the [Logger.log](-logger/log.md) function using the [Loggable.logValues](-loggable/log-values.md) obtained from the provided [loggable](log.md) instance. | +| [verbose](verbose.md) | [common]
inline fun [Logger](-logger/index.md).[verbose](verbose.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null)
inline fun [Logger](-logger/index.md).[verbose](verbose.md)(tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null, messageBuilder: () -> [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?)
Invokes the [Logger.log](-logger/log.md) function for [LogType.VERBOSE](-log-type/-v-e-r-b-o-s-e/index.md). | +| [warning](warning.md) | [common]
inline fun [Logger](-logger/index.md).[warning](warning.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null)
inline fun [Logger](-logger/index.md).[warning](warning.md)(tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null, messageBuilder: () -> [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?)
Invokes the [Logger.log](-logger/log.md) function for [LogType.WARNING](-log-type/-w-a-r-n-i-n-g/index.md). | +| [wtf](wtf.md) | [common]
inline fun [Logger](-logger/index.md).[wtf](wtf.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null)
inline fun [Logger](-logger/index.md).[wtf](wtf.md)(tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null, messageBuilder: () -> [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?)
Invokes the [Logger.log](-logger/log.md) function for [LogType.WTF](-log-type/-w-t-f/index.md). | diff --git a/docs/logger-core/logger-core/com.chrynan.logger/info.md b/docs/logger-core/logger-core/com.chrynan.logger/info.md new file mode 100644 index 0000000..1fdfd37 --- /dev/null +++ b/docs/logger-core/logger-core/com.chrynan.logger/info.md @@ -0,0 +1,10 @@ +//[logger-core](../../index.md)/[com.chrynan.logger](index.md)/[info](info.md) + +# info + +[common]\ +inline fun [Logger](-logger/index.md).[info](info.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) + +inline fun [Logger](-logger/index.md).[info](info.md)(tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null, messageBuilder: () -> [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?) + +Invokes the [Logger.log](-logger/log.md) function for [LogType.INFO](-log-type/-i-n-f-o/index.md). diff --git a/docs/logger-core/logger-core/com.chrynan.logger/log.md b/docs/logger-core/logger-core/com.chrynan.logger/log.md index 316d25a..b65e855 100644 --- a/docs/logger-core/logger-core/com.chrynan.logger/log.md +++ b/docs/logger-core/logger-core/com.chrynan.logger/log.md @@ -3,6 +3,11 @@ # log [common]\ -fun [Logger](-logger/index.md).[log](log.md)(logValues: [LogValues](-log-values/index.md)) +inline fun [Logger](-logger/index.md).[log](log.md)(logValues: [LogValues](-log-values/index.md)) -fun [Logger](-logger/index.md).[log](log.md)(loggable: [Loggable](-loggable/index.md)) +Invokes the [Logger.log](-logger/log.md) function using the provided [logValues](log.md). + +[common]\ +inline fun [Logger](-logger/index.md).[log](log.md)(loggable: [Loggable](-loggable/index.md)) + +Invokes the [Logger.log](-logger/log.md) function using the [Loggable.logValues](-loggable/log-values.md) obtained from the provided [loggable](log.md) instance. diff --git a/docs/logger-core/logger-core/com.chrynan.logger/verbose.md b/docs/logger-core/logger-core/com.chrynan.logger/verbose.md new file mode 100644 index 0000000..dafb9c9 --- /dev/null +++ b/docs/logger-core/logger-core/com.chrynan.logger/verbose.md @@ -0,0 +1,10 @@ +//[logger-core](../../index.md)/[com.chrynan.logger](index.md)/[verbose](verbose.md) + +# verbose + +[common]\ +inline fun [Logger](-logger/index.md).[verbose](verbose.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) + +inline fun [Logger](-logger/index.md).[verbose](verbose.md)(tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null, messageBuilder: () -> [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?) + +Invokes the [Logger.log](-logger/log.md) function for [LogType.VERBOSE](-log-type/-v-e-r-b-o-s-e/index.md). diff --git a/docs/logger-core/logger-core/com.chrynan.logger/warning.md b/docs/logger-core/logger-core/com.chrynan.logger/warning.md new file mode 100644 index 0000000..5160fca --- /dev/null +++ b/docs/logger-core/logger-core/com.chrynan.logger/warning.md @@ -0,0 +1,10 @@ +//[logger-core](../../index.md)/[com.chrynan.logger](index.md)/[warning](warning.md) + +# warning + +[common]\ +inline fun [Logger](-logger/index.md).[warning](warning.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) + +inline fun [Logger](-logger/index.md).[warning](warning.md)(tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null, messageBuilder: () -> [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?) + +Invokes the [Logger.log](-logger/log.md) function for [LogType.WARNING](-log-type/-w-a-r-n-i-n-g/index.md). diff --git a/docs/logger-core/logger-core/com.chrynan.logger/wtf.md b/docs/logger-core/logger-core/com.chrynan.logger/wtf.md new file mode 100644 index 0000000..4535046 --- /dev/null +++ b/docs/logger-core/logger-core/com.chrynan.logger/wtf.md @@ -0,0 +1,10 @@ +//[logger-core](../../index.md)/[com.chrynan.logger](index.md)/[wtf](wtf.md) + +# wtf + +[common]\ +inline fun [Logger](-logger/index.md).[wtf](wtf.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null) + +inline fun [Logger](-logger/index.md).[wtf](wtf.md)(tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? = null, messageBuilder: () -> [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?) + +Invokes the [Logger.log](-logger/log.md) function for [LogType.WTF](-log-type/-w-t-f/index.md). diff --git a/docs/logger-ktor-client/index.md b/docs/logger-ktor-client/index.md new file mode 100644 index 0000000..c476556 --- /dev/null +++ b/docs/logger-ktor-client/index.md @@ -0,0 +1,9 @@ +//[logger-ktor-client](index.md) + +# logger-ktor-client + +## Packages + +| Name | +|---| +| [com.chrynan.logger.ktor.client](logger-ktor-client/com.chrynan.logger.ktor.client/index.md) | diff --git a/docs/logger-ktor-client/logger-ktor-client/com.chrynan.logger.ktor.client/-ktor-logger/-ktor-logger.md b/docs/logger-ktor-client/logger-ktor-client/com.chrynan.logger.ktor.client/-ktor-logger/-ktor-logger.md new file mode 100644 index 0000000..c1e2cb1 --- /dev/null +++ b/docs/logger-ktor-client/logger-ktor-client/com.chrynan.logger.ktor.client/-ktor-logger/-ktor-logger.md @@ -0,0 +1,6 @@ +//[logger-ktor-client](../../../index.md)/[com.chrynan.logger.ktor.client](../index.md)/[KtorLogger](index.md)/[KtorLogger](-ktor-logger.md) + +# KtorLogger + +[common]\ +fun [KtorLogger](-ktor-logger.md)(logger: [Logger](../../../../logger-core/logger-core/com.chrynan.logger/-logger/index.md) = Log, defaultLogType: [LogType](../../../../logger-core/logger-core/com.chrynan.logger/-log-type/index.md) = LogType.VERBOSE, defaultTag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null) diff --git a/docs/logger-ktor-client/logger-ktor-client/com.chrynan.logger.ktor.client/-ktor-logger/equals.md b/docs/logger-ktor-client/logger-ktor-client/com.chrynan.logger.ktor.client/-ktor-logger/equals.md new file mode 100644 index 0000000..1dd83d5 --- /dev/null +++ b/docs/logger-ktor-client/logger-ktor-client/com.chrynan.logger.ktor.client/-ktor-logger/equals.md @@ -0,0 +1,6 @@ +//[logger-ktor-client](../../../index.md)/[com.chrynan.logger.ktor.client](../index.md)/[KtorLogger](index.md)/[equals](equals.md) + +# equals + +[common]\ +open operator override fun [equals](equals.md)(other: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)?): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) diff --git a/docs/logger-ktor-client/logger-ktor-client/com.chrynan.logger.ktor.client/-ktor-logger/hash-code.md b/docs/logger-ktor-client/logger-ktor-client/com.chrynan.logger.ktor.client/-ktor-logger/hash-code.md new file mode 100644 index 0000000..80ab217 --- /dev/null +++ b/docs/logger-ktor-client/logger-ktor-client/com.chrynan.logger.ktor.client/-ktor-logger/hash-code.md @@ -0,0 +1,6 @@ +//[logger-ktor-client](../../../index.md)/[com.chrynan.logger.ktor.client](../index.md)/[KtorLogger](index.md)/[hashCode](hash-code.md) + +# hashCode + +[common]\ +open override fun [hashCode](hash-code.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) diff --git a/docs/logger-ktor-client/logger-ktor-client/com.chrynan.logger.ktor.client/-ktor-logger/index.md b/docs/logger-ktor-client/logger-ktor-client/com.chrynan.logger.ktor.client/-ktor-logger/index.md new file mode 100644 index 0000000..e4ab64a --- /dev/null +++ b/docs/logger-ktor-client/logger-ktor-client/com.chrynan.logger.ktor.client/-ktor-logger/index.md @@ -0,0 +1,40 @@ +//[logger-ktor-client](../../../index.md)/[com.chrynan.logger.ktor.client](../index.md)/[KtorLogger](index.md) + +# KtorLogger + +[common]\ +class [KtorLogger](index.md)(logger: [Logger](../../../../logger-core/logger-core/com.chrynan.logger/-logger/index.md) = Log, defaultLogType: [LogType](../../../../logger-core/logger-core/com.chrynan.logger/-log-type/index.md) = LogType.VERBOSE, defaultTag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null) : [Logger](../../../../logger-core/logger-core/com.chrynan.logger/-logger/index.md), Logger + +A [com.chrynan.logger.Logger](../../../../logger-core/logger-core/com.chrynan.logger/-logger/index.md) and io.ktor.client.plugins.logging.Logger implementation that delegates to the provided [logger](../../../../logger-ktor-client/com.chrynan.logger.ktor.client/-ktor-logger/logger.md) for all the log calls. This class is meant to create a bridge between this logging library and the Ktor Client Logging plugin. + +Example usage: + +```kotlin +val client = HttpClient(CIO) { + install(Logging) { + logger = KtorLogger(defaultLogType = LogType.INFO) + level = LogLevel.HEADERS + } +} +``` + +## Constructors + +| | | +|---|---| +| [KtorLogger](-ktor-logger.md) | [common]
fun [KtorLogger](-ktor-logger.md)(logger: [Logger](../../../../logger-core/logger-core/com.chrynan.logger/-logger/index.md) = Log, defaultLogType: [LogType](../../../../logger-core/logger-core/com.chrynan.logger/-log-type/index.md) = LogType.VERBOSE, defaultTag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null) | + +## Functions + +| Name | Summary | +|---|---| +| [equals](equals.md) | [common]
open operator override fun [equals](equals.md)(other: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)?): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | +| [hashCode](hash-code.md) | [common]
open override fun [hashCode](hash-code.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [log](log.md) | [common]
open override fun [log](log.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html))
open override fun [log](index.md#-1060515817%2FFunctions%2F-1679481623)(logType: [LogType](../../../../logger-core/logger-core/com.chrynan.logger/-log-type/index.md), tag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?, throwable: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)?) | +| [toString](to-string.md) | [common]
open override fun [toString](to-string.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | + +## Properties + +| Name | Summary | +|---|---| +| [isEnabled](index.md#636237714%2FProperties%2F-1679481623) | [common]
open override var [isEnabled](index.md#636237714%2FProperties%2F-1679481623): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | diff --git a/docs/logger-ktor-client/logger-ktor-client/com.chrynan.logger.ktor.client/-ktor-logger/log.md b/docs/logger-ktor-client/logger-ktor-client/com.chrynan.logger.ktor.client/-ktor-logger/log.md new file mode 100644 index 0000000..1130848 --- /dev/null +++ b/docs/logger-ktor-client/logger-ktor-client/com.chrynan.logger.ktor.client/-ktor-logger/log.md @@ -0,0 +1,6 @@ +//[logger-ktor-client](../../../index.md)/[com.chrynan.logger.ktor.client](../index.md)/[KtorLogger](index.md)/[log](log.md) + +# log + +[common]\ +open override fun [log](log.md)(message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) diff --git a/docs/logger-ktor-client/logger-ktor-client/com.chrynan.logger.ktor.client/-ktor-logger/to-string.md b/docs/logger-ktor-client/logger-ktor-client/com.chrynan.logger.ktor.client/-ktor-logger/to-string.md new file mode 100644 index 0000000..8269ffa --- /dev/null +++ b/docs/logger-ktor-client/logger-ktor-client/com.chrynan.logger.ktor.client/-ktor-logger/to-string.md @@ -0,0 +1,6 @@ +//[logger-ktor-client](../../../index.md)/[com.chrynan.logger.ktor.client](../index.md)/[KtorLogger](index.md)/[toString](to-string.md) + +# toString + +[common]\ +open override fun [toString](to-string.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) diff --git a/docs/logger-ktor-client/logger-ktor-client/com.chrynan.logger.ktor.client/index.md b/docs/logger-ktor-client/logger-ktor-client/com.chrynan.logger.ktor.client/index.md new file mode 100644 index 0000000..0ffd62b --- /dev/null +++ b/docs/logger-ktor-client/logger-ktor-client/com.chrynan.logger.ktor.client/index.md @@ -0,0 +1,9 @@ +//[logger-ktor-client](../../index.md)/[com.chrynan.logger.ktor.client](index.md) + +# Package com.chrynan.logger.ktor.client + +## Types + +| Name | Summary | +|---|---| +| [KtorLogger](-ktor-logger/index.md) | [common]
class [KtorLogger](-ktor-logger/index.md)(logger: [Logger](../../../logger-core/logger-core/com.chrynan.logger/-logger/index.md) = Log, defaultLogType: [LogType](../../../logger-core/logger-core/com.chrynan.logger/-log-type/index.md) = LogType.VERBOSE, defaultTag: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null) : [Logger](../../../logger-core/logger-core/com.chrynan.logger/-logger/index.md), Logger
A [com.chrynan.logger.Logger](../../../logger-core/logger-core/com.chrynan.logger/-logger/index.md) and io.ktor.client.plugins.logging.Logger implementation that delegates to the provided [logger](../../../logger-ktor-client/com.chrynan.logger.ktor.client/-ktor-logger/logger.md) for all the log calls. This class is meant to create a bridge between this logging library and the Ktor Client Logging plugin. | diff --git a/docs/package-list b/docs/package-list index 5c083ca..583dc1e 100644 --- a/docs/package-list +++ b/docs/package-list @@ -4,10 +4,33 @@ $dokka.location:com.chrynan.logger.android.timber////PointingToDeclaration/logg $dokka.location:com.chrynan.logger.android.timber/TimberLogger///PointingToDeclaration/logger-android-timber/logger-android-timber/com.chrynan.logger.android.timber/-timber-logger/index.md $dokka.location:com.chrynan.logger.android.timber/TimberLogger/TimberLogger/#/PointingToDeclaration/logger-android-timber/logger-android-timber/com.chrynan.logger.android.timber/-timber-logger/-timber-logger.md $dokka.location:com.chrynan.logger.android.timber/TimberLogger/log/#com.chrynan.logger.LogType#kotlin.String#kotlin.String?#kotlin.Throwable?/PointingToDeclaration/logger-android-timber/logger-android-timber/com.chrynan.logger.android.timber/-timber-logger/log.md +$dokka.location:com.chrynan.logger.ktor.client////PointingToDeclaration/logger-ktor-client/logger-ktor-client/com.chrynan.logger.ktor.client/index.md +$dokka.location:com.chrynan.logger.ktor.client/KtorLogger///PointingToDeclaration/logger-ktor-client/logger-ktor-client/com.chrynan.logger.ktor.client/-ktor-logger/index.md +$dokka.location:com.chrynan.logger.ktor.client/KtorLogger/KtorLogger/#com.chrynan.logger.Logger#com.chrynan.logger.LogType#kotlin.String?/PointingToDeclaration/logger-ktor-client/logger-ktor-client/com.chrynan.logger.ktor.client/-ktor-logger/-ktor-logger.md +$dokka.location:com.chrynan.logger.ktor.client/KtorLogger/equals/#kotlin.Any?/PointingToDeclaration/logger-ktor-client/logger-ktor-client/com.chrynan.logger.ktor.client/-ktor-logger/equals.md +$dokka.location:com.chrynan.logger.ktor.client/KtorLogger/hashCode/#/PointingToDeclaration/logger-ktor-client/logger-ktor-client/com.chrynan.logger.ktor.client/-ktor-logger/hash-code.md +$dokka.location:com.chrynan.logger.ktor.client/KtorLogger/log/#kotlin.String/PointingToDeclaration/logger-ktor-client/logger-ktor-client/com.chrynan.logger.ktor.client/-ktor-logger/log.md +$dokka.location:com.chrynan.logger.ktor.client/KtorLogger/toString/#/PointingToDeclaration/logger-ktor-client/logger-ktor-client/com.chrynan.logger.ktor.client/-ktor-logger/to-string.md $dokka.location:com.chrynan.logger////PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/index.md $dokka.location:com.chrynan.logger//DefaultLogger/#/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-default-logger.md +$dokka.location:com.chrynan.logger//debug/com.chrynan.logger.Logger#kotlin.String?#kotlin.String?#kotlin.Throwable?/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/debug.md +$dokka.location:com.chrynan.logger//debug/com.chrynan.logger.Logger#kotlin.String?#kotlin.Throwable?#kotlin.Function0[kotlin.String?]/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/debug.md +$dokka.location:com.chrynan.logger//error/com.chrynan.logger.Logger#kotlin.String?#kotlin.String?#kotlin.Throwable?/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/error.md +$dokka.location:com.chrynan.logger//error/com.chrynan.logger.Logger#kotlin.String?#kotlin.Throwable?#kotlin.Function0[kotlin.String?]/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/error.md +$dokka.location:com.chrynan.logger//info/com.chrynan.logger.Logger#kotlin.String?#kotlin.String?#kotlin.Throwable?/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/info.md +$dokka.location:com.chrynan.logger//info/com.chrynan.logger.Logger#kotlin.String?#kotlin.Throwable?#kotlin.Function0[kotlin.String?]/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/info.md $dokka.location:com.chrynan.logger//log/com.chrynan.logger.Logger#com.chrynan.logger.LogValues/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/log.md $dokka.location:com.chrynan.logger//log/com.chrynan.logger.Logger#com.chrynan.logger.Loggable/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/log.md +$dokka.location:com.chrynan.logger//verbose/com.chrynan.logger.Logger#kotlin.String?#kotlin.String?#kotlin.Throwable?/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/verbose.md +$dokka.location:com.chrynan.logger//verbose/com.chrynan.logger.Logger#kotlin.String?#kotlin.Throwable?#kotlin.Function0[kotlin.String?]/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/verbose.md +$dokka.location:com.chrynan.logger//warning/com.chrynan.logger.Logger#kotlin.String?#kotlin.String?#kotlin.Throwable?/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/warning.md +$dokka.location:com.chrynan.logger//warning/com.chrynan.logger.Logger#kotlin.String?#kotlin.Throwable?#kotlin.Function0[kotlin.String?]/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/warning.md +$dokka.location:com.chrynan.logger//wtf/com.chrynan.logger.Logger#kotlin.String?#kotlin.String?#kotlin.Throwable?/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/wtf.md +$dokka.location:com.chrynan.logger//wtf/com.chrynan.logger.Logger#kotlin.String?#kotlin.Throwable?#kotlin.Function0[kotlin.String?]/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/wtf.md +$dokka.location:com.chrynan.logger/AsyncLogger///PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-async-logger/index.md +$dokka.location:com.chrynan.logger/AsyncLogger/AsyncLogger/#/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-async-logger/-async-logger.md +$dokka.location:com.chrynan.logger/AsyncLogger/isEnabled/#/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-async-logger/is-enabled.md +$dokka.location:com.chrynan.logger/AsyncLogger/log/#com.chrynan.logger.LogType#kotlin.String#kotlin.String?#kotlin.Throwable?/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-async-logger/log.md $dokka.location:com.chrynan.logger/ConsoleLogger///PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-console-logger/index.md $dokka.location:com.chrynan.logger/ConsoleLogger/ConsoleLogger/#/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-console-logger/-console-logger.md $dokka.location:com.chrynan.logger/ConsoleLogger/init/#/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-console-logger/init.md @@ -15,9 +38,12 @@ $dokka.location:com.chrynan.logger/ConsoleLogger/isEnabled/#/PointingToDeclarati $dokka.location:com.chrynan.logger/ConsoleLogger/log/#com.chrynan.logger.LogType#kotlin.String#kotlin.String?#kotlin.Throwable?/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-console-logger/log.md $dokka.location:com.chrynan.logger/DelegatingLogger///PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-delegating-logger/index.md $dokka.location:com.chrynan.logger/DelegatingLogger/DelegatingLogger/#kotlin.collections.Set[com.chrynan.logger.Logger]#kotlin.Boolean/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-delegating-logger/-delegating-logger.md +$dokka.location:com.chrynan.logger/DelegatingLogger/equals/#kotlin.Any?/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-delegating-logger/equals.md +$dokka.location:com.chrynan.logger/DelegatingLogger/hashCode/#/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-delegating-logger/hash-code.md $dokka.location:com.chrynan.logger/DelegatingLogger/init/#/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-delegating-logger/init.md $dokka.location:com.chrynan.logger/DelegatingLogger/isEnabled/#/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-delegating-logger/is-enabled.md $dokka.location:com.chrynan.logger/DelegatingLogger/log/#com.chrynan.logger.LogType#kotlin.String#kotlin.String?#kotlin.Throwable?/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-delegating-logger/log.md +$dokka.location:com.chrynan.logger/DelegatingLogger/toString/#/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-delegating-logger/to-string.md $dokka.location:com.chrynan.logger/JavaAnnotationProcessorMessagerLogger///PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-java-annotation-processor-messager-logger/index.md $dokka.location:com.chrynan.logger/JavaAnnotationProcessorMessagerLogger/JavaAnnotationProcessorMessagerLogger/#javax.annotation.processing.Messager/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-java-annotation-processor-messager-logger/-java-annotation-processor-messager-logger.md $dokka.location:com.chrynan.logger/JavaAnnotationProcessorMessagerLogger/init/#/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-java-annotation-processor-messager-logger/init.md @@ -32,6 +58,7 @@ $dokka.location:com.chrynan.logger/Log///PointingToDeclaration/logger-core/logg $dokka.location:com.chrynan.logger/Log/init/#/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-log/init.md $dokka.location:com.chrynan.logger/Log/isEnabled/#/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-log/is-enabled.md $dokka.location:com.chrynan.logger/Log/log/#com.chrynan.logger.LogType#kotlin.String#kotlin.String?#kotlin.Throwable?/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-log/log.md +$dokka.location:com.chrynan.logger/Log/logValues/#/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-log/log-values.md $dokka.location:com.chrynan.logger/Log/logger/#/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-log/logger.md $dokka.location:com.chrynan.logger/LogCatLogger///PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-log-cat-logger/index.md $dokka.location:com.chrynan.logger/LogCatLogger/LogCatLogger/#/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-log-cat-logger/-log-cat-logger.md @@ -42,12 +69,12 @@ $dokka.location:com.chrynan.logger/LogInitializer///PointingToDeclaration/logge $dokka.location:com.chrynan.logger/LogInitializer/init/#/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-log-initializer/init.md $dokka.location:com.chrynan.logger/LogType.Companion///PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-log-type/-companion/index.md $dokka.location:com.chrynan.logger/LogType.Companion/getByTypeName/#kotlin.String#kotlin.Boolean/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-log-type/-companion/get-by-type-name.md -$dokka.location:com.chrynan.logger/LogType.DEBUG///PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-log-type/-d-e-b-u-g/index.md -$dokka.location:com.chrynan.logger/LogType.ERROR///PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-log-type/-e-r-r-o-r/index.md -$dokka.location:com.chrynan.logger/LogType.INFO///PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-log-type/-i-n-f-o/index.md -$dokka.location:com.chrynan.logger/LogType.VERBOSE///PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-log-type/-v-e-r-b-o-s-e/index.md -$dokka.location:com.chrynan.logger/LogType.WARNING///PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-log-type/-w-a-r-n-i-n-g/index.md -$dokka.location:com.chrynan.logger/LogType.WTF///PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-log-type/-w-t-f/index.md +$dokka.location:com.chrynan.logger/LogType.DEBUG///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}logger-core/logger-core/com.chrynan.logger/-log-type/-d-e-b-u-g/index.md +$dokka.location:com.chrynan.logger/LogType.ERROR///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}logger-core/logger-core/com.chrynan.logger/-log-type/-e-r-r-o-r/index.md +$dokka.location:com.chrynan.logger/LogType.INFO///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}logger-core/logger-core/com.chrynan.logger/-log-type/-i-n-f-o/index.md +$dokka.location:com.chrynan.logger/LogType.VERBOSE///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}logger-core/logger-core/com.chrynan.logger/-log-type/-v-e-r-b-o-s-e/index.md +$dokka.location:com.chrynan.logger/LogType.WARNING///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}logger-core/logger-core/com.chrynan.logger/-log-type/-w-a-r-n-i-n-g/index.md +$dokka.location:com.chrynan.logger/LogType.WTF///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}logger-core/logger-core/com.chrynan.logger/-log-type/-w-t-f/index.md $dokka.location:com.chrynan.logger/LogType///PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-log-type/index.md $dokka.location:com.chrynan.logger/LogType/typeName/#/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-log-type/type-name.md $dokka.location:com.chrynan.logger/LogValues///PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-log-values/index.md @@ -59,14 +86,8 @@ $dokka.location:com.chrynan.logger/LogValues/throwable/#/PointingToDeclaration/ $dokka.location:com.chrynan.logger/Loggable///PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-loggable/index.md $dokka.location:com.chrynan.logger/Loggable/logValues/#/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-loggable/log-values.md $dokka.location:com.chrynan.logger/Logger///PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-logger/index.md -$dokka.location:com.chrynan.logger/Logger/debug/#kotlin.String?#kotlin.String?#kotlin.Throwable?/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-logger/debug.md -$dokka.location:com.chrynan.logger/Logger/error/#kotlin.String?#kotlin.String?#kotlin.Throwable?/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-logger/error.md -$dokka.location:com.chrynan.logger/Logger/info/#kotlin.String?#kotlin.String?#kotlin.Throwable?/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-logger/info.md $dokka.location:com.chrynan.logger/Logger/isEnabled/#/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-logger/is-enabled.md $dokka.location:com.chrynan.logger/Logger/log/#com.chrynan.logger.LogType#kotlin.String#kotlin.String?#kotlin.Throwable?/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-logger/log.md -$dokka.location:com.chrynan.logger/Logger/verbose/#kotlin.String?#kotlin.String?#kotlin.Throwable?/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-logger/verbose.md -$dokka.location:com.chrynan.logger/Logger/warning/#kotlin.String?#kotlin.String?#kotlin.Throwable?/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-logger/warning.md -$dokka.location:com.chrynan.logger/Logger/wtf/#kotlin.String?#kotlin.String?#kotlin.Throwable?/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-logger/wtf.md $dokka.location:com.chrynan.logger/NSLogger///PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-n-s-logger/index.md $dokka.location:com.chrynan.logger/NSLogger/NSLogger/#/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-n-s-logger/-n-s-logger.md $dokka.location:com.chrynan.logger/NSLogger/init/#/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-n-s-logger/init.md @@ -77,13 +98,15 @@ $dokka.location:com.chrynan.logger/NoActionLogger/NoActionLogger/#/PointingToDec $dokka.location:com.chrynan.logger/NoActionLogger/init/#/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-no-action-logger/init.md $dokka.location:com.chrynan.logger/NoActionLogger/isEnabled/#/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-no-action-logger/is-enabled.md $dokka.location:com.chrynan.logger/NoActionLogger/log/#com.chrynan.logger.LogType#kotlin.String#kotlin.String?#kotlin.Throwable?/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-no-action-logger/log.md -$dokka.location:com.chrynan.logger/SimplePrintLineLogger.Companion///PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-simple-print-line-logger/-companion/index.md -$dokka.location:com.chrynan.logger/SimplePrintLineLogger///PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-simple-print-line-logger/index.md -$dokka.location:com.chrynan.logger/SimplePrintLineLogger/SimplePrintLineLogger/#/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-simple-print-line-logger/-simple-print-line-logger.md -$dokka.location:com.chrynan.logger/SimplePrintLineLogger/init/#/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-simple-print-line-logger/init.md -$dokka.location:com.chrynan.logger/SimplePrintLineLogger/isEnabled/#/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-simple-print-line-logger/is-enabled.md -$dokka.location:com.chrynan.logger/SimplePrintLineLogger/log/#com.chrynan.logger.LogType#kotlin.String#kotlin.String?#kotlin.Throwable?/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-simple-print-line-logger/log.md +$dokka.location:com.chrynan.logger/PrintLineLogger.Companion///PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-print-line-logger/-companion/index.md +$dokka.location:com.chrynan.logger/PrintLineLogger///PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-print-line-logger/index.md +$dokka.location:com.chrynan.logger/PrintLineLogger/PrintLineLogger/#/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-print-line-logger/-print-line-logger.md +$dokka.location:com.chrynan.logger/PrintLineLogger/init/#/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-print-line-logger/init.md +$dokka.location:com.chrynan.logger/PrintLineLogger/isEnabled/#/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-print-line-logger/is-enabled.md +$dokka.location:com.chrynan.logger/PrintLineLogger/log/#com.chrynan.logger.LogType#kotlin.String#kotlin.String?#kotlin.Throwable?/PointingToDeclaration/logger-core/logger-core/com.chrynan.logger/-print-line-logger/log.md module:logger-android-timber com.chrynan.logger.android.timber module:logger-core com.chrynan.logger +module:logger-ktor-client +com.chrynan.logger.ktor.client