From a9be511b052755258bc92225c4f5a8977f174b89 Mon Sep 17 00:00:00 2001 From: "sebastian.sellmair" Date: Thu, 20 Aug 2020 10:59:28 +0200 Subject: Add task descriptions to all dokka tasks --- .../src/main/kotlin/org/jetbrains/dokka/gradle/main.kt | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) (limited to 'runners/gradle-plugin/src/main') diff --git a/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/main.kt b/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/main.kt index 8ba28e83..f5dc9366 100644 --- a/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/main.kt +++ b/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/main.kt @@ -8,21 +8,26 @@ import org.gradle.kotlin.dsl.register open class DokkaPlugin : Plugin { override fun apply(project: Project) { - project.setupDokkaTasks("dokkaHtml") + project.setupDokkaTasks("dokkaHtml") { + description = "Generates documentation in 'html' format" + } project.setupDokkaTasks( name = "dokkaJavadoc", multiModuleTaskSupported = false ) { plugins.dependencies.add(project.dokkaArtifacts.javadocPlugin) + description = "Generates documentation in 'javadoc' format" } project.setupDokkaTasks("dokkaGfm") { plugins.dependencies.add(project.dokkaArtifacts.gfmPlugin) + description = "Generates documentation in GitHub flavored markdown format" } project.setupDokkaTasks("dokkaJekyll") { plugins.dependencies.add(project.dokkaArtifacts.jekyllPlugin) + description = "Generates documentation in Jekyll flavored markdown format" } } @@ -47,10 +52,13 @@ open class DokkaPlugin : Plugin { val multiModuleName = "${name}MultiModule" project.maybeCreateDokkaPluginConfiguration(multiModuleName) project.maybeCreateDokkaRuntimeConfiguration(multiModuleName) + project.tasks.register(multiModuleName) { addSubprojectChildTasks(name) configuration() + description = "Runs all subprojects '$name' tasks and generates module navigation page" } + project.tasks.register("${name}Multimodule") { dependsOn(multiModuleName) doLast { @@ -61,6 +69,8 @@ open class DokkaPlugin : Plugin { if (collectorTaskSupported) { project.tasks.register("${name}Collector") { addSubprojectChildTasks(name) + description = + "Generates documentation merging all subprojects '$name' tasks into one virtual module" } } } -- cgit