Skip to content

Commit d20ac3c

Browse files
committed
upgrade dokka to v2
1 parent 327013b commit d20ac3c

File tree

2 files changed

+28
-8
lines changed

2 files changed

+28
-8
lines changed

build.gradle.kts

Lines changed: 27 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
// File: build.gradle.kts
22
import org.gradle.api.tasks.testing.logging.TestExceptionFormat.FULL
33
import org.gradle.jvm.tasks.Jar
4+
import org.jetbrains.dokka.gradle.DokkaTask
5+
import org.jetbrains.dokka.gradle.DokkaTaskPartial
46
import org.jetbrains.kotlin.gradle.ExperimentalKotlinGradlePluginApi
57
import org.jetbrains.kotlin.gradle.dsl.JvmTarget
68
import org.jetbrains.kotlin.gradle.dsl.KotlinVersion
@@ -285,13 +287,7 @@ tasks {
285287

286288
// Docs
287289

288-
tasks {
289-
register<Jar>("dokkaJar") {
290-
from(dokkaHtml)
291-
dependsOn(dokkaHtml)
292-
archiveClassifier.set("javadoc")
293-
}
294-
}
290+
295291

296292

297293
// Tests
@@ -357,7 +353,7 @@ publishing {
357353
url.set("https://github.com/oshai/kotlin-logging/tree/master")
358354
}
359355
}
360-
artifact(tasks["dokkaJar"])
356+
361357
}
362358
}
363359

@@ -385,4 +381,27 @@ tasks.withType<AbstractPublishToMaven>().configureEach {
385381
val signingTasks = tasks.withType<Sign>()
386382
mustRunAfter(signingTasks)
387383
}
384+
tasks.withType<DokkaTaskPartial>().configureEach {
385+
dokkaSourceSets.configureEach {
386+
// We want to see all declarations, even if they are not explicitly documented.
387+
reportUndocumented.set(true)
388+
}
389+
}
390+
391+
val dokkaHtmlPublication by tasks.creating(DokkaTask::class) {
392+
outputDirectory.set(buildDir.resolve("dokka/html"))
393+
}
394+
395+
val javadocJar by tasks.register<Jar>("javadocJar") {
396+
dependsOn(dokkaHtmlPublication)
397+
from(dokkaHtmlPublication.outputDirectory)
398+
archiveClassifier.set("javadoc")
399+
}
400+
401+
publishing {
402+
publications.withType<MavenPublication> {
403+
artifact(javadocJar)
404+
}
405+
}
406+
388407
//endregion

gradle.properties

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,4 @@ org.gradle.jvmargs=-Xmx2048m
44
# see https://kotlinlang.org/docs/whatsnew18.html#sourcedirectories
55
kotlin.mpp.androidSourceSetLayoutVersion=2
66
kotlin.mpp.applyDefaultHierarchyTemplate=false
7+
org.jetbrains.dokka.experimental.gradle.pluginMode=V2Enabled

0 commit comments

Comments
 (0)