Skip to content

Commit

Permalink
Generated updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
chRyNaN committed Jan 14, 2022
1 parent 8cceda2 commit 45d9f06
Show file tree
Hide file tree
Showing 58 changed files with 506 additions and 210 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,23 @@
# TimberLogger

[androidJvm]\
abstract class [TimberLogger](index.md) : [LogInitializer](../../../../logger-core/logger-core/com.chrynan.logger/-log-initializer/index.md), [Loggable](../../../../logger-core/logger-core/com.chrynan.logger/-loggable/index.md)
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)

## Functions

| Name | Summary |
|---|---|
| [debug](index.md#528699424%2FFunctions%2F1672300378) | [androidJvm]<br>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]<br>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]<br>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]<br>abstract fun [init](index.md#1639196271%2FFunctions%2F1672300378)() |
| [log](log.md) | [androidJvm]<br>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)?) |
| [logDebug](index.md#-1390990663%2FFunctions%2F1672300378) | [androidJvm]<br>open fun [logDebug](index.md#-1390990663%2FFunctions%2F1672300378)(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)?, message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?) |
| [logError](index.md#852670830%2FFunctions%2F1672300378) | [androidJvm]<br>open fun [logError](index.md#852670830%2FFunctions%2F1672300378)(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)?, message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?) |
| [logInfo](index.md#60983358%2FFunctions%2F1672300378) | [androidJvm]<br>open fun [logInfo](index.md#60983358%2FFunctions%2F1672300378)(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)?, message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?) |
| [logVerbose](index.md#557716520%2FFunctions%2F1672300378) | [androidJvm]<br>open fun [logVerbose](index.md#557716520%2FFunctions%2F1672300378)(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)?, message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?) |
| [logWarning](index.md#-1320828862%2FFunctions%2F1672300378) | [androidJvm]<br>open fun [logWarning](index.md#-1320828862%2FFunctions%2F1672300378)(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)?, message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?) |
| [logWtf](index.md#1642696271%2FFunctions%2F1672300378) | [androidJvm]<br>open fun [logWtf](index.md#1642696271%2FFunctions%2F1672300378)(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)?, message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?) |
| [verbose](index.md#-736659633%2FFunctions%2F1672300378) | [androidJvm]<br>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]<br>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]<br>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

| Name | Summary |
|---|---|
| [isEnabled](index.md#636237714%2FProperties%2F1672300378) | [androidJvm]<br>abstract var [isEnabled](index.md#636237714%2FProperties%2F1672300378): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) |
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@

| Name | Summary |
|---|---|
| [TimberLogger](-timber-logger/index.md) | [androidJvm]<br>abstract class [TimberLogger](-timber-logger/index.md) : [LogInitializer](../../../logger-core/logger-core/com.chrynan.logger/-log-initializer/index.md), [Loggable](../../../logger-core/logger-core/com.chrynan.logger/-loggable/index.md) |
| [TimberLogger](-timber-logger/index.md) | [androidJvm]<br>abstract class [TimberLogger](-timber-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) |
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,23 @@
# ConsoleLogger

[js]\
open class [ConsoleLogger](index.md) : [LogInitializer](../-log-initializer/index.md), [Loggable](../-loggable/index.md)
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)

## Functions

| Name | Summary |
|---|---|
| [debug](index.md#528699424%2FFunctions%2F332244294) | [js]<br>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]<br>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]<br>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]<br>open override fun [init](init.md)() |
| [log](log.md) | [js]<br>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)?) |
| [logDebug](index.md#-1390990663%2FFunctions%2F332244294) | [js]<br>open fun [logDebug](index.md#-1390990663%2FFunctions%2F332244294)(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, message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null) |
| [logError](index.md#852670830%2FFunctions%2F332244294) | [js]<br>open fun [logError](index.md#852670830%2FFunctions%2F332244294)(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, message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null) |
| [logInfo](index.md#60983358%2FFunctions%2F332244294) | [js]<br>open fun [logInfo](index.md#60983358%2FFunctions%2F332244294)(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, message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null) |
| [logVerbose](index.md#557716520%2FFunctions%2F332244294) | [js]<br>open fun [logVerbose](index.md#557716520%2FFunctions%2F332244294)(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, message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null) |
| [logWarning](index.md#-1320828862%2FFunctions%2F332244294) | [js]<br>open fun [logWarning](index.md#-1320828862%2FFunctions%2F332244294)(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, message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null) |
| [logWtf](index.md#1642696271%2FFunctions%2F332244294) | [js]<br>open fun [logWtf](index.md#1642696271%2FFunctions%2F332244294)(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, message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null) |
| [log](log.md) | [js]<br>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]<br>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]<br>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]<br>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) |

## Properties

| Name | Summary |
|---|---|
| [isEnabled](is-enabled.md) | [js]<br>open override var [isEnabled](is-enabled.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = true<br>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. |
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
//[logger-core](../../../index.md)/[com.chrynan.logger](../index.md)/[ConsoleLogger](index.md)/[isEnabled](is-enabled.md)

# isEnabled

[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.

**Note:** that it is up to the call-site to prevent logging if this value returns false.
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
# log

[js]\
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)?)
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)?)
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,8 @@
# DefaultLogger

[common, android, ios, js, jvm]\
[common, android, ios, js, jvm]\
fun [DefaultLogger](-default-logger.md)(): [Loggable](-loggable/index.md)
[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)
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
//[logger-core](../../../index.md)/[com.chrynan.logger](../index.md)/[DelegatingLogger](index.md)/[DelegatingLogger](-delegating-logger.md)

# DelegatingLogger

[common]\
fun [DelegatingLogger](-delegating-logger.md)(loggers: [Set](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.html)&lt;[Logger](../-logger/index.md)&gt;, delegateIsEnabledChanges: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false)
Loading

0 comments on commit 45d9f06

Please sign in to comment.