Skip to content

Enabling dokka project-wide #2021

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

Draft
Jolanrensen wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Enabling dokka project-wide #2021

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
9 changes: 9 additions & 0 deletions build-logic/src/main/kotlin/dfbuild.kodex.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import dfbuild.findRootDir
import nl.jolanrensen.kodex.gradle.KodexIsolationMode
import nl.jolanrensen.kodex.gradle.RunKodexTask
import org.jetbrains.dokka.gradle.DokkaExtension

plugins {
alias(conventions.plugins.dfbuild.kotlinJvmCommon)
Expand Down Expand Up @@ -218,3 +219,11 @@ tasks.configureEach {
dependsOn(processKDocsMain, changeJarTask)
}
}

afterEvaluate {
extensions.configure<DokkaExtension> {
dokkaSourceSets.named("main") {
sourceRoots.setFrom(generatedMainSources.kotlin.srcDirs)
}
}
}
13 changes: 13 additions & 0 deletions build-logic/src/main/kotlin/dfbuild.kotlinJvmCommon.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,16 @@
import org.jetbrains.dokka.gradle.engine.parameters.VisibilityModifier.Internal
import org.jetbrains.dokka.gradle.engine.parameters.VisibilityModifier.Package
import org.jetbrains.dokka.gradle.engine.parameters.VisibilityModifier.Protected
import org.jetbrains.dokka.gradle.engine.parameters.VisibilityModifier.Public

plugins {
alias(conventions.plugins.dfbuild.base)
// enables the linter for every Kotlin module in the project
alias(conventions.plugins.dfbuild.ktlint)

alias(libs.plugins.kotlin.jvm)

alias(libs.plugins.dokka)
}

kotlin {
Expand All @@ -23,3 +30,9 @@ artifacts {
builtBy(tasks.jar)
}
}

dokka {
dokkaSourceSets.configureEach {
documentedVisibilities(Public, Protected, Internal, Package)
}
}
12 changes: 11 additions & 1 deletion build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ plugins {
with(libs.plugins) {
alias(publisher)
alias(serialization) apply false
alias(dokka)
}
}

Expand Down Expand Up @@ -42,6 +41,17 @@ dependencies {

// experimental, so not included by default:
// api(projects.dataframeOpenapi)

dokka(projects.core)
dokka(projects.dataframeArrow)
dokka(projects.dataframeExcel)
dokka(projects.dataframeJdbc)
dokka(projects.dataframeCsv)
dokka(projects.dataframeJson)
dokka(projects.dataframeGeo)
dokka(projects.dataframeGeoJupyter)
dokka(projects.dataframeOpenapi)
dokka(projects.dataframeOpenapiGenerator)
}

group = "org.jetbrains.kotlinx"
Expand Down
Loading