Skip to content

Commit fd290b5

Browse files
committed
Add package docs for Dokka
1 parent b27bc7c commit fd290b5

File tree

2 files changed

+11
-2
lines changed

2 files changed

+11
-2
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# devlog-kotlin
22

33
Structured logging library for Kotlin, that aims to provide a developer-friendly API with near-zero
4-
runtime overhead. Currently only supports the JVM platform, wrapping SLF4J and Logback.
4+
runtime overhead. Currently only supports the JVM platform, wrapping SLF4J.
55

66
- Docs: https://devlog-kotlin.hermannm.dev
77
- Published on:

gradle/dokka/module-docs.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,19 @@
11
# Module devlog-kotlin
22

33
Structured logging library for Kotlin, that aims to provide a developer-friendly API with near-zero
4-
runtime overhead. Currently only supports the JVM platform, wrapping SLF4J and Logback.
4+
runtime overhead. Currently only supports the JVM platform, wrapping SLF4J.
55

66
Repository: <https://github.com/hermannm/devlog-kotlin>
77

88
This site hosts the docstrings for public classes and functions in `devlog-kotlin`. For a
99
higher-level introduction to the library, see
1010
the ["Usage" section in the README on GitHub](https://github.com/hermannm/devlog-kotlin#usage).
11+
12+
# Package dev.hermannm.devlog
13+
14+
The main package of `devlog-kotlin`, providing the `Logger` API.
15+
16+
# Package dev.hermannm.devlog.output.logback
17+
18+
Provides extensions for formatting log output when using `devlog-kotlin` with the
19+
[Logback](https://logback.qos.ch/) library on the JVM.

0 commit comments

Comments
 (0)