Skip to content

Commit

Permalink
T.scholze/35 add kdoc (#36)
Browse files Browse the repository at this point in the history
  • Loading branch information
tscholze authored Nov 27, 2022
2 parents 195c480 + f71ecc9 commit 307d105
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,14 @@ Otherwise, Kotlog will try to load the configuration file (`~/.kotlog`) from the
Do not use this tool in production or something else besides education! I just started studying Kotlin and have no idea if the source generated or consumed by the CSS is GDPR or something else compliant.
If you have any other warnings for me, please open an issue. I'm here to learn!

## How to document
Kotlog uses [KDoc and Dokka](https://kotlinlang.org/docs/kotlin-doc.html) to document the Kotlin files it self. To run or update the documentation run one of the following Gradle commands:

* `dokkaGfm` - generate GH flavored markdown documentation
* `dokkaHtml` - generate HTML documentation

After the task was successful, the generated documentation can be found in the `build/`folder.

## Thanks to
The app is built on the work of giants. Without the following folks, repositories and posts, my tiny project would not exist.

Expand Down
1 change: 1 addition & 0 deletions build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ version = "1.0.7"
plugins {
kotlin("jvm") version "1.7.10"
kotlin("plugin.serialization") version "1.7.10"
id("org.jetbrains.dokka") version "1.7.20"
application
}

Expand Down

0 comments on commit 307d105

Please sign in to comment.