aboutsummaryrefslogtreecommitdiff
path: root/runners
diff options
context:
space:
mode:
authorBłażej Kardyś <bkardys@virtuslab.com>2020-11-20 17:23:10 +0100
committerBłażej Kardyś <bkardys@virtuslab.com>2020-11-27 03:15:02 +0100
commit3cb4702a68139788de6e1f7b087ced345f2b71ba (patch)
treea383471c9915ae4aaff078b4f3b81bb99a4fde35 /runners
parent076a5f421c5e4621539efd814be612f43fef33f5 (diff)
downloaddokka-3cb4702a68139788de6e1f7b087ced345f2b71ba.tar.gz
dokka-3cb4702a68139788de6e1f7b087ced345f2b71ba.tar.bz2
dokka-3cb4702a68139788de6e1f7b087ced345f2b71ba.zip
Changing how multimodule location provider works and improving gfm link substitution
Diffstat (limited to 'runners')
-rw-r--r--runners/cli/src/main/kotlin/cli/main.kt2
-rw-r--r--runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/DokkaArtifacts.kt2
-rw-r--r--runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/DokkaMultiModuleTask.kt1
-rw-r--r--runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/main.kt8
4 files changed, 6 insertions, 7 deletions
diff --git a/runners/cli/src/main/kotlin/cli/main.kt b/runners/cli/src/main/kotlin/cli/main.kt
index 9cfee73b..290950ec 100644
--- a/runners/cli/src/main/kotlin/cli/main.kt
+++ b/runners/cli/src/main/kotlin/cli/main.kt
@@ -66,7 +66,7 @@ class GlobalArguments(args: Array<String>) : DokkaConfiguration {
override val delayTemplateSubstitution by parser.option(
ArgType.Boolean,
- description = "Delay substitution of some elements (usefull for incremental builds of multimoule projects)"
+ description = "Delay substitution of some elements (usefull for incremental builds of multimodule projects)"
).default(DokkaDefaults.delayTemplateSubstitution)
val globalPackageOptions by parser.option(
diff --git a/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/DokkaArtifacts.kt b/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/DokkaArtifacts.kt
index cca1b3f8..f5d7e9c8 100644
--- a/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/DokkaArtifacts.kt
+++ b/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/DokkaArtifacts.kt
@@ -14,6 +14,6 @@ internal class DokkaArtifacts(private val project: Project) {
val dokkaBase get() = fromModuleName("dokka-base")
val javadocPlugin get() = fromModuleName("javadoc-plugin")
val gfmPlugin get() = fromModuleName("gfm-plugin")
- val gfmAllModulesPagePlugin get() = fromModuleName("gfm-all-module-page-plugin")
+ val gfmTemplateProcessing get() = fromModuleName("gfm-template-processing-plugin")
val jekyllPlugin get() = fromModuleName("jekyll-plugin")
}
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 4139a0cd..c68b53b8 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
@@ -43,7 +43,6 @@ abstract class DokkaMultiModuleTask : AbstractDokkaParentTask() {
override fun generateDocumentation() {
checkChildDokkaTasksIsNotEmpty()
-// copyChildOutputDirectories()
super.generateDocumentation()
}
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 3c89100e..4da14120 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
@@ -21,12 +21,12 @@ open class DokkaPlugin : Plugin<Project> {
description = "Generates documentation in 'javadoc' format"
}
- project.setupDokkaTasks("dokkaGfm", allModulesPage = project.dokkaArtifacts.gfmAllModulesPagePlugin) {
+ project.setupDokkaTasks("dokkaGfm", allModulesPageAndTemplateProcessing = project.dokkaArtifacts.gfmTemplateProcessing) {
plugins.dependencies.add(project.dokkaArtifacts.gfmPlugin)
description = "Generates documentation in GitHub flavored markdown format"
}
- project.setupDokkaTasks("dokkaJekyll", allModulesPage = project.dokkaArtifacts.gfmAllModulesPagePlugin) {
+ project.setupDokkaTasks("dokkaJekyll", allModulesPageAndTemplateProcessing = project.dokkaArtifacts.gfmTemplateProcessing) {
plugins.dependencies.add(project.dokkaArtifacts.jekyllPlugin)
description = "Generates documentation in Jekyll flavored markdown format"
}
@@ -39,7 +39,7 @@ open class DokkaPlugin : Plugin<Project> {
private fun Project.setupDokkaTasks(
name: String,
multiModuleTaskSupported: Boolean = true,
- allModulesPage: Dependency = project.dokkaArtifacts.allModulesPage,
+ allModulesPageAndTemplateProcessing: Dependency = project.dokkaArtifacts.allModulesPage,
collectorTaskSupported: Boolean = true,
configuration: AbstractDokkaTask.() -> Unit = {}
) {
@@ -65,7 +65,7 @@ open class DokkaPlugin : Plugin<Project> {
addSubprojectChildTasks("${name}Partial")
configuration()
description = "Runs all subprojects '$name' tasks and generates module navigation page"
- plugins.dependencies.add(allModulesPage)
+ plugins.dependencies.add(allModulesPageAndTemplateProcessing)
}
project.tasks.register<DefaultTask>("${name}Multimodule") {