Skip to content

Commit

Permalink
Initially add code to generate KDoc HTML with Dokka
Browse files Browse the repository at this point in the history
  • Loading branch information
ShreckYe committed Nov 5, 2024
1 parent 142225d commit 39fb14c
Show file tree
Hide file tree
Showing 5 changed files with 50 additions and 0 deletions.
25 changes: 25 additions & 0 deletions build.gradle.kts
Original file line number Diff line number Diff line change
@@ -1,3 +1,28 @@
import com.huanshankeji.cpnProject

tasks.wrapper {
distributionType = Wrapper.DistributionType.ALL
}

plugins {
id("org.jetbrains.dokka")
}

dependencies {
listOf(
"core",
"net",
"web",

"arrow",
"coroutines",
"exposed",
"ktor:client",
"reflect",
"serialization",
"vertx",
"vertx:with-context-receivers",
).forEach {
dokka(cpnProject(project, ":$it"))
}
}
1 change: 1 addition & 0 deletions buildSrc/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,5 @@ dependencies {
implementation(kotlin("gradle-plugin", "2.0.10"))
implementation("com.huanshankeji:common-gradle-dependencies:0.8.0-20241016") // don't use a snapshot version in a main branch
implementation("com.huanshankeji.team:gradle-plugins:0.6.0") // don't use a snapshot version in a main branch
implementation("org.jetbrains.dokka:dokka-gradle-plugin:2.0.0-Beta")
}
1 change: 1 addition & 0 deletions buildSrc/src/main/kotlin/common-conventions.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ plugins {
id("com.huanshankeji.team.with-group")
id("maven-central")
id("com.huanshankeji.team.default-github-packages-maven-publish")
id("dokka-convention")
}

version = projectVersion
Expand Down
21 changes: 21 additions & 0 deletions buildSrc/src/main/kotlin/dokka-convention.gradle.kts
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
plugins {
id("org.jetbrains.dokka")
}

dokka {
// TODO
/*
moduleName.set("Huanshankeji Kotlin Common")
dokkaSourceSets.named("main") {
includes.from("README.md")
sourceLink {
localDirectory.set(file("src/main/kotlin"))
remoteUrl("https://github.com/huanshankeji/kotlin-common/tree/v${version}")
remoteLineSuffix.set("#L")
}
pluginsConfiguration.html {
footerMessage.set("(c) Yongshun Ye")
}
}
*/
}
2 changes: 2 additions & 0 deletions gradle.properties
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
kotlin.mpp.stability.nowarn=true
# needed for the GitHub Actions CI
org.gradle.jvmargs=-Xmx4G
# for Dokka
org.jetbrains.dokka.experimental.gradle.pluginMode=V2Enabled

0 comments on commit 39fb14c

Please sign in to comment.