diff options
author | sebastian.sellmair <sebastian.sellmair@jetbrains.com> | 2020-07-14 18:40:00 +0200 |
---|---|---|
committer | Sebastian Sellmair <34319766+sellmair@users.noreply.github.com> | 2020-07-15 09:04:20 +0200 |
commit | 0d2bc7387b518c7c25e42c9966241426c86f30f6 (patch) | |
tree | aa3dd07e846193a44dcf6dabfb033a1939103ed7 | |
parent | 3fc8223f92ba140dbfa8e8371157b3bf782bda85 (diff) | |
download | dokka-0d2bc7387b518c7c25e42c9966241426c86f30f6.tar.gz dokka-0d2bc7387b518c7c25e42c9966241426c86f30f6.tar.bz2 dokka-0d2bc7387b518c7c25e42c9966241426c86f30f6.zip |
Decalre documentation group for all dokka tasks
3 files changed, 23 insertions, 0 deletions
diff --git a/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/DokkaCollectorTask.kt b/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/DokkaCollectorTask.kt index 38da9631..37952ea8 100644 --- a/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/DokkaCollectorTask.kt +++ b/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/DokkaCollectorTask.kt @@ -1,6 +1,8 @@ package org.jetbrains.dokka.gradle import org.gradle.api.DefaultTask +import org.gradle.api.plugins.JavaBasePlugin +import org.gradle.api.plugins.JavaBasePlugin.DOCUMENTATION_GROUP import org.gradle.api.tasks.Input import org.gradle.api.tasks.TaskAction import java.lang.IllegalStateException @@ -48,6 +50,8 @@ open class DokkaCollectorTask : DefaultTask() { dokkaTaskNames.forEach { dokkaTaskName -> finalizedBy(dokkaTaskName) } + + group = DOCUMENTATION_GROUP } diff --git a/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/DokkaMultimoduleTask.kt b/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/DokkaMultimoduleTask.kt index cc7b8d86..6fd58afe 100644 --- a/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/DokkaMultimoduleTask.kt +++ b/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/DokkaMultimoduleTask.kt @@ -1,6 +1,8 @@ package org.jetbrains.dokka.gradle import com.google.gson.GsonBuilder +import org.gradle.api.plugins.JavaBasePlugin +import org.gradle.api.plugins.JavaBasePlugin.DOCUMENTATION_GROUP import org.gradle.api.tasks.Input import org.gradle.api.tasks.Internal import org.jetbrains.dokka.plugability.Configurable @@ -59,4 +61,8 @@ open class DokkaMultimoduleTask : AbstractDokkaTask(), Configurable { private fun getSubprojectDokkaTasks(dokkaTaskNames: Set<String>): List<DokkaTask> { return dokkaTaskNames.flatMap { dokkaTaskName -> getSubprojectDokkaTasks(dokkaTaskName) } } + + init { + group = DOCUMENTATION_GROUP + } } diff --git a/runners/gradle-plugin/src/test/kotlin/org/jetbrains/dokka/gradle/DokkaTasksTest.kt b/runners/gradle-plugin/src/test/kotlin/org/jetbrains/dokka/gradle/DokkaTasksTest.kt index 66283876..b948c540 100644 --- a/runners/gradle-plugin/src/test/kotlin/org/jetbrains/dokka/gradle/DokkaTasksTest.kt +++ b/runners/gradle-plugin/src/test/kotlin/org/jetbrains/dokka/gradle/DokkaTasksTest.kt @@ -1,8 +1,10 @@ package org.jetbrains.dokka.gradle +import org.gradle.api.plugins.JavaBasePlugin import org.gradle.kotlin.dsl.withType import org.gradle.testfixtures.ProjectBuilder import kotlin.test.Test +import kotlin.test.assertEquals import kotlin.test.assertSame import kotlin.test.assertTrue @@ -49,4 +51,15 @@ class DokkaTasksTest { } } + @Test + fun `all dokka tasks are part of the documentation group`() { + val project = ProjectBuilder.builder().build() + project.plugins.apply("org.jetbrains.dokka") + project.tasks.filter { "dokka" in it.name.toLowerCase() }.forEach { dokkaTask -> + assertEquals( + JavaBasePlugin.DOCUMENTATION_GROUP, dokkaTask.group, + "Expected task: ${dokkaTask.path} group to be ${JavaBasePlugin.DOCUMENTATION_GROUP}" + ) + } + } } |