Skip to content
This repository has been archived by the owner on Jul 31, 2022. It is now read-only.

Commit

Permalink
chore: add descriptions to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
auguwu committed Jun 21, 2022
1 parent 4c34264 commit 43a5ab6
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 5 deletions.
5 changes: 0 additions & 5 deletions buildSrc/src/main/kotlin/sh/nino/towa/gradle/Metadata.kt
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,3 @@ val VERSION = Version(1, 0, 0, 0, ReleaseType.None)
* artifacts.
*/
val JAVA_VERSION = JavaVersion.VERSION_17

/**
* Returns the commit hash of the Git repository.
*/
// val COMMIT_HASH by lazy {}
1 change: 1 addition & 0 deletions buildSrc/src/main/kotlin/towa-module.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,7 @@ tasks {
dokkaHtml {
dokkaSourceSets {
configureEach {
moduleName.set("towa-${project.name}")
platform.set(org.jetbrains.dokka.Platform.jvm)
jdkVersion.set(17)
includes.from("DokkaDescription.md")
Expand Down
16 changes: 16 additions & 0 deletions core/DokkaDescription.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Module towa-core
**towa-core** is the main core package that is used by the [slash-commands](https://towa.nino.sh/slash-commands/index.html) package. It
is also recommended to bundle **towa-core** as a dependency if you wish to use the Extensions feature.

```kotlin
suspend fun main(args: Array<String>) {
val towa = Towa { // this: sh.nino.towa.core.TowaBuilder
kord("token") { // this: KordBuilder
enableShutdownHook = false
}
}

towa.start()
towa.kord.login()
}
```
4 changes: 4 additions & 0 deletions locator-koin/DokkaDescription.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Module towa-locator-koin
**locator-koin** is the package that uses **Koin** to find any object from your dependency injection tree. This package
only implements [KoinLoader](https://towa.nino.sh/locator-koin/sh.nino.towa.locator.koin/-koin-locator/index.html) which extends
[sh.nino.towa.core.locator.Locator](https://towa.nino.sh/core/sh.nino.towa.core.locator/-locator/index.html).
4 changes: 4 additions & 0 deletions slash-commands/DokkaDescription.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Module towa-slash-commands
**slash-commands** is a Towa extension to use the Slash Commands framework.

You can see an example project [here](https://github.com/NinoDiscord/towa/tree/master/test).

0 comments on commit 43a5ab6

Please sign in to comment.