From 9fe122861006b2e3e945fa2e4d91513d48bffcf7 Mon Sep 17 00:00:00 2001 From: aSemy <897017+aSemy@users.noreply.github.com> Date: Wed, 12 Oct 2022 23:03:24 +0200 Subject: Rename DokkaPlugin file (#2701) --- .../org/jetbrains/dokka/gradle/DokkaPlugin.kt | 91 ++++++++++++++++++++++ .../main/kotlin/org/jetbrains/dokka/gradle/main.kt | 91 ---------------------- 2 files changed, 91 insertions(+), 91 deletions(-) create mode 100644 runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/DokkaPlugin.kt delete mode 100644 runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/main.kt (limited to 'runners/gradle-plugin') 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 new file mode 100644 index 00000000..691d9f6d --- /dev/null +++ b/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/DokkaPlugin.kt @@ -0,0 +1,91 @@ +package org.jetbrains.dokka.gradle + +import org.gradle.api.DefaultTask +import org.gradle.api.Plugin +import org.gradle.api.Project +import org.gradle.api.artifacts.Dependency +import org.gradle.kotlin.dsl.register +import org.gradle.util.GradleVersion + +open class DokkaPlugin : Plugin { + override fun apply(project: Project) { + if (GradleVersion.version(project.gradle.gradleVersion) < GradleVersion.version("5.6")) { + project.logger.warn("Dokka: Build is using unsupported gradle version, expected at least 5.6 but got ${project.gradle.gradleVersion}. This may result in strange errors") + } + + 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", allModulesPageAndTemplateProcessing = project.dokkaArtifacts.gfmTemplateProcessing) { + plugins.dependencies.add(project.dokkaArtifacts.gfmPlugin) + description = "Generates documentation in GitHub flavored markdown format" + } + + project.setupDokkaTasks("dokkaJekyll", allModulesPageAndTemplateProcessing = project.dokkaArtifacts.jekyllTemplateProcessing) { + plugins.dependencies.add(project.dokkaArtifacts.jekyllPlugin) + description = "Generates documentation in Jekyll flavored markdown format" + } + } + + /** + * Creates [DokkaTask], [DokkaMultiModuleTask] for the given + * name and configuration. + */ + private fun Project.setupDokkaTasks( + name: String, + multiModuleTaskSupported: Boolean = true, + allModulesPageAndTemplateProcessing: Dependency = project.dokkaArtifacts.allModulesPage, + configuration: AbstractDokkaTask.() -> Unit = {} + ) { + project.maybeCreateDokkaPluginConfiguration(name) + project.maybeCreateDokkaRuntimeConfiguration(name) + project.tasks.register(name) { + configuration() + } + + if (project.parent != null) { + val partialName = "${name}Partial" + project.maybeCreateDokkaPluginConfiguration(partialName) + project.maybeCreateDokkaRuntimeConfiguration(partialName) + project.tasks.register(partialName) { + configuration() + } + } + + if (project.subprojects.isNotEmpty()) { + if (multiModuleTaskSupported) { + val multiModuleName = "${name}MultiModule" + project.maybeCreateDokkaPluginConfiguration(multiModuleName, setOf(allModulesPageAndTemplateProcessing)) + project.maybeCreateDokkaRuntimeConfiguration(multiModuleName) + + project.tasks.register(multiModuleName) { + addSubprojectChildTasks("${name}Partial") + configuration() + description = "Runs all subprojects '$name' tasks and generates module navigation page" + } + + project.tasks.register("${name}Multimodule") { + dependsOn(multiModuleName) + doLast { + logger.warn("'Multimodule' is deprecated. Use 'MultiModule' instead") + } + } + } + + project.tasks.register("${name}Collector") { + addSubprojectChildTasks(name) + description = + "Generates documentation merging all subprojects '$name' tasks into one virtual module" + } + } + } +} 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 deleted file mode 100644 index 691d9f6d..00000000 --- a/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/main.kt +++ /dev/null @@ -1,91 +0,0 @@ -package org.jetbrains.dokka.gradle - -import org.gradle.api.DefaultTask -import org.gradle.api.Plugin -import org.gradle.api.Project -import org.gradle.api.artifacts.Dependency -import org.gradle.kotlin.dsl.register -import org.gradle.util.GradleVersion - -open class DokkaPlugin : Plugin { - override fun apply(project: Project) { - if (GradleVersion.version(project.gradle.gradleVersion) < GradleVersion.version("5.6")) { - project.logger.warn("Dokka: Build is using unsupported gradle version, expected at least 5.6 but got ${project.gradle.gradleVersion}. This may result in strange errors") - } - - 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", allModulesPageAndTemplateProcessing = project.dokkaArtifacts.gfmTemplateProcessing) { - plugins.dependencies.add(project.dokkaArtifacts.gfmPlugin) - description = "Generates documentation in GitHub flavored markdown format" - } - - project.setupDokkaTasks("dokkaJekyll", allModulesPageAndTemplateProcessing = project.dokkaArtifacts.jekyllTemplateProcessing) { - plugins.dependencies.add(project.dokkaArtifacts.jekyllPlugin) - description = "Generates documentation in Jekyll flavored markdown format" - } - } - - /** - * Creates [DokkaTask], [DokkaMultiModuleTask] for the given - * name and configuration. - */ - private fun Project.setupDokkaTasks( - name: String, - multiModuleTaskSupported: Boolean = true, - allModulesPageAndTemplateProcessing: Dependency = project.dokkaArtifacts.allModulesPage, - configuration: AbstractDokkaTask.() -> Unit = {} - ) { - project.maybeCreateDokkaPluginConfiguration(name) - project.maybeCreateDokkaRuntimeConfiguration(name) - project.tasks.register(name) { - configuration() - } - - if (project.parent != null) { - val partialName = "${name}Partial" - project.maybeCreateDokkaPluginConfiguration(partialName) - project.maybeCreateDokkaRuntimeConfiguration(partialName) - project.tasks.register(partialName) { - configuration() - } - } - - if (project.subprojects.isNotEmpty()) { - if (multiModuleTaskSupported) { - val multiModuleName = "${name}MultiModule" - project.maybeCreateDokkaPluginConfiguration(multiModuleName, setOf(allModulesPageAndTemplateProcessing)) - project.maybeCreateDokkaRuntimeConfiguration(multiModuleName) - - project.tasks.register(multiModuleName) { - addSubprojectChildTasks("${name}Partial") - configuration() - description = "Runs all subprojects '$name' tasks and generates module navigation page" - } - - project.tasks.register("${name}Multimodule") { - dependsOn(multiModuleName) - doLast { - logger.warn("'Multimodule' is deprecated. Use 'MultiModule' instead") - } - } - } - - project.tasks.register("${name}Collector") { - addSubprojectChildTasks(name) - description = - "Generates documentation merging all subprojects '$name' tasks into one virtual module" - } - } - } -} -- cgit