Skip to content

Simplify Dokka source link configuration #2524

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 5, 2023
Merged

Simplify Dokka source link configuration #2524

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 2 additions & 8 deletions gradle/dokka.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,6 @@ def documentedSubprojects = ["kotlinx-serialization-core",
"kotlinx-serialization-hocon",
"kotlinx-serialization-protobuf"]

def jvmOnlySubprojects = ["kotlinx-serialization-hocon"]

subprojects {
if (!(name in documentedSubprojects)) return
apply plugin: 'org.jetbrains.dokka'
Expand Down Expand Up @@ -77,12 +75,8 @@ subprojects {
}

sourceLink {
// sources directory for MPP configured in gradle/configure-source-sets.gradle:61
// in short - kotlin.srcDirs = ["$sourceSet.name/src"]
def sourcesPath = project.name in jvmOnlySubprojects ? "src/main/kotlin" : "$name/src"
def relProjectPath = rootProject.projectDir.toPath().relativize(projectDir.toPath())
localDirectory.set(file(sourcesPath))
remoteUrl.set(new URL("https://github.com/Kotlin/kotlinx.serialization/tree/master/$relProjectPath/$sourcesPath"))
localDirectory.set(rootDir)
remoteUrl.set(new URL("https://github.com/Kotlin/kotlinx.serialization/tree/master"))
remoteLineSuffix.set("#L")
}
}
Expand Down