diff options
| author | Róbert Papp <papp.robert.s@gmail.com> | 2023-02-01 12:35:09 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-02-01 13:35:09 +0100 |
| commit | ed6c67bd55ad0211b9be40dda3027340eecd5919 (patch) | |
| tree | 8fd5370f72af217eeed5bd130573e653cd2d28e4 /runners/gradle-plugin/src/main/kotlin/org/jetbrains | |
| parent | fe360f7fadc7173be3ae170778a93ebd01962149 (diff) | |
| download | dokka-ed6c67bd55ad0211b9be40dda3027340eecd5919.tar.gz dokka-ed6c67bd55ad0211b9be40dda3027340eecd5919.tar.bz2 dokka-ed6c67bd55ad0211b9be40dda3027340eecd5919.zip | |
Add missing group and description for Multimodule tasks (#2806)
* Change warning level as requested https://github.com/Kotlin/dokka/pull/2806#pullrequestreview-1278096135
* Change the group of deprecated tasks to "deprecated" according to conversation https://github.com/Kotlin/dokka/pull/2806/files#r1093042654
* Use lazy resolution of tasks and explicit test for deprecation.
Diffstat (limited to 'runners/gradle-plugin/src/main/kotlin/org/jetbrains')
| -rw-r--r-- | runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/DokkaMultiModuleTask.kt | 2 | ||||
| -rw-r--r-- | runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/DokkaPlugin.kt | 3 |
2 files changed, 4 insertions, 1 deletions
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 2fd452a5..4186bdda 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 @@ -9,7 +9,7 @@ import org.jetbrains.dokka.DokkaModuleDescriptionImpl import java.io.File @Suppress("unused") // Shall provide source compatibility if possible -@Deprecated("Use 'DokkaMultimoduleTask' instead", ReplaceWith("DokkaMultimoduleTask")) +@Deprecated("Use 'DokkaMultiModuleTask' instead", ReplaceWith("DokkaMultiModuleTask"), DeprecationLevel.ERROR) typealias DokkaMultimoduleTask = DokkaMultiModuleTask private typealias TaskPath = String diff --git a/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/DokkaPlugin.kt b/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/DokkaPlugin.kt index 691d9f6d..4027f844 100644 --- a/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/DokkaPlugin.kt +++ b/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/DokkaPlugin.kt @@ -4,6 +4,7 @@ import org.gradle.api.DefaultTask import org.gradle.api.Plugin import org.gradle.api.Project import org.gradle.api.artifacts.Dependency +import org.gradle.api.plugins.JavaBasePlugin import org.gradle.kotlin.dsl.register import org.gradle.util.GradleVersion @@ -74,6 +75,8 @@ open class DokkaPlugin : Plugin<Project> { } project.tasks.register<DefaultTask>("${name}Multimodule") { + group = "deprecated" + description = "DEPRECATED: 'Multimodule' is deprecated. Use 'MultiModule' instead." dependsOn(multiModuleName) doLast { logger.warn("'Multimodule' is deprecated. Use 'MultiModule' instead") |