Skip to content

Commit

Permalink
Adjust configuration options and correct the source URL
Browse files Browse the repository at this point in the history
There is a problem that when I open the generated root "index.html" from IntelliJ IDEA, it shows the "kotlin-common-serialization" module. This may be a bug of IntelliJ IDEA, or a bug of Dokka, or the result of my misconfiguration.
  • Loading branch information
ShreckYe committed Nov 5, 2024
1 parent 39fb14c commit 2905545
Showing 1 changed file with 13 additions and 10 deletions.
23 changes: 13 additions & 10 deletions buildSrc/src/main/kotlin/dokka-convention.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,22 @@ plugins {
}

dokka {
// TODO
/*
moduleName.set("Huanshankeji Kotlin Common")
dokkaSourceSets.named("main") {
includes.from("README.md")
//moduleName.set("Huanshankeji Kotlin Common")
dokkaSourceSets.all {
//includes.from("README.md")
sourceLink {
localDirectory.set(file("src/main/kotlin"))
remoteUrl("https://github.com/huanshankeji/kotlin-common/tree/v${version}")
//localDirectory.set(file("src/main/kotlin"))
remoteUrl(
"https://github.com/huanshankeji/kotlin-common/tree/v${version}/${
with(project) {
name.removePrefix(parent!!.name + '-')
}
}"
)
remoteLineSuffix.set("#L")
}
pluginsConfiguration.html {
/*pluginsConfiguration.html {
footerMessage.set("(c) Yongshun Ye")
}
}*/
}
*/
}

1 comment on commit 2905545

@ShreckYe
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As checked with the GitHub Pages deployment at https://huanshankeji.github.io/kotlin-common/, the problem is probaly an IntelliJ IDEA bug.

Please sign in to comment.