Skip to content

Move samples and packages configuration of Dokka to convention plugin #321

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
May 10, 2024
Merged

Move samples and packages configuration of Dokka to convention plugin #321

Show file tree
Hide file tree
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
13 changes: 13 additions & 0 deletions build-logic/src/main/kotlin/kotlinx/io/conventions/kotlinx-io-dokka.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,5 +19,18 @@ tasks.withType<DokkaTaskPartial>().configureEach {
remoteUrl.set(URL("https://github.com/kotlin/kotlinx-io/tree/master"))
remoteLineSuffix.set("#L")
}

// we don't want to advertise `unsafe` APIs in documentation
perPackageOption {
suppress.set(true)
matchingRegex.set(".*unsafe.*")
}

// as in kotlinx-io-multiplatform.gradle.kts:configureSourceSet
val platform = name.dropLast(4)
samples.from(
"common/test/samples",
"$platform/test/samples"
)
}
}
14 changes: 0 additions & 14 deletions bytestring/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
import org.jetbrains.dokka.gradle.DokkaTaskPartial

plugins {
id("kotlinx-io-multiplatform")
id("kotlinx-io-publish")
Expand All @@ -26,15 +24,3 @@ kotlin {
}
}
}


tasks.withType<DokkaTaskPartial>().configureEach {
dokkaSourceSets.configureEach {
perPackageOption {
suppress.set(true)
matchingRegex.set(".*unsafe.*")
}

samples.from("common/test/samples/samples.kt")
}
}
15 changes: 0 additions & 15 deletions core/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
*/

import org.gradle.internal.os.OperatingSystem
import org.jetbrains.dokka.gradle.DokkaTaskPartial

plugins {
id("kotlinx-io-multiplatform")
Expand Down Expand Up @@ -53,20 +52,6 @@ kotlin {
}
}

tasks.withType<DokkaTaskPartial>().configureEach {
dokkaSourceSets.configureEach {
samples.from(
"common/test/samples/rawSinkSample.kt",
"common/test/samples/rawSourceSample.kt",
"common/test/samples/moduleDescriptionSample.kt",
"common/test/samples/samples.kt",
"common/test/samples/byteStringSample.kt",
"jvm/test/samples/samplesJvm.kt",
"apple/test/samples/samplesApple.kt"
)
}
}

tasks.named("wasmWasiNodeTest") {
// TODO: remove once https://youtrack.jetbrains.com/issue/KT-65179 solved
doFirst {
Expand Down