Open
Description
Describe the bug
I tried following the migration guide for v2 but got stuck at a few points migrating the following:
tasks.withType<DokkaTask>().configureEach {
suppressInheritedMembers = true
failOnWarning = true
outputDirectory = layout.projectDirectory.dir("../website/static/kdoc/detekt-gradle-plugin")
dokkaSourceSets.configureEach {
apiVersion = "1.4"
externalDocumentationLink {
url = URI("https://docs.gradle.org/current/javadoc/").toURL()
}
}
}
The migration guide suggests tasks.withType<DokkaTask>().configureEach {
is replaced with dokka {
but some parameters aren't supported on the new extensions.
There is no guidance in deprecation warnings in the IDE, nor documentation in the migration guide, for these task properties:
- failOnWarning
- externalDocumentationLink
Expected behaviour
Migration guide should cover all changes to existing properties, whether they're now unsupported, or have a replacement.
Screenshots
To Reproduce
Set this in a project with dokka plugin applied:
dokka {
failOnWarning = true
outputDirectory = layout.projectDirectory.dir("../website/static/kdoc/detekt-gradle-plugin")
dokkaSourceSets.configureEach {
apiVersion = "1.4"
externalDocumentationLink {
url = URI("https://docs.gradle.org/current/javadoc/").toURL()
}
}
dokkaPublications.configureEach {
suppressInheritedMembers = true
}
}
Dokka configuration
Installation
- Operating system: Windows
- Build tool: Gradle v8.12.1
- Dokka version: 2.0.0
Additional context
Add any other context about the problem here