Skip to content

Commit 88f79e3

Browse files
committed
typos and docs
1 parent 5c29717 commit 88f79e3

File tree

2 files changed

+21
-2
lines changed

2 files changed

+21
-2
lines changed

src/main/kotlin/mu/KLogger.kt

+19
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,37 @@ import org.slf4j.Logger
99
*/
1010
class KLogger(jLogger: Logger): Logger by jLogger{
1111

12+
/**
13+
* Lazy add a log message if isTraceEnabled is true
14+
*/
1215
inline fun trace(msg: () -> Any?) {
1316
if (isTraceEnabled) trace(msg.invoke().toString())
1417
}
18+
19+
/**
20+
* Lazy add a log message if isDebugEnabled is true
21+
*/
1522
inline fun debug(msg: () -> Any?) {
1623
if (isDebugEnabled) debug(msg.invoke().toString())
1724
}
25+
26+
/**
27+
* Lazy add a log message if isInfoEnabled is true
28+
*/
1829
inline fun info(msg: () -> Any?) {
1930
if (isInfoEnabled) info(msg.invoke().toString())
2031
}
32+
33+
/**
34+
* Lazy add a log message if isWarnEnabled is true
35+
*/
2136
inline fun warn(msg: () -> Any?) {
2237
if (isWarnEnabled) warn(msg.invoke().toString())
2338
}
39+
40+
/**
41+
* Lazy add a log message if isErrorEnabled is true
42+
*/
2443
inline fun error(msg: () -> Any?) {
2544
if (isErrorEnabled) error(msg.invoke().toString())
2645
}

src/main/kotlin/mu/KLogging.kt

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ package mu
33
import mu.internal.KLoggerFactory
44

55
/**
6-
* An class with logging capabilities
6+
* A class with logging capabilities
77
* usage example:
88
* class ClassWithLogging {
99
* companion object: KLogging()
@@ -17,7 +17,7 @@ open class KLogging : KLoggable {
1717
}
1818

1919
/**
20-
* An class with logging capabilities and explicit logger name
20+
* A class with logging capabilities and explicit logger name
2121
*/
2222
open class NamedKLogging(name: String): KLoggable {
2323
override val logger: KLogger = logger(name)

0 commit comments

Comments
 (0)