From 02ccae10e3f717c330dae5d87b49a0e72f798905 Mon Sep 17 00:00:00 2001 From: "sebastian.sellmair" Date: Fri, 28 Aug 2020 11:28:54 +0200 Subject: Re-use includes form child tasks for all modules page generation --- .../gradle/projects/it-multimodule-0/moduleA/moduleB/Module.md | 6 ++++++ .../gradle/projects/it-multimodule-0/moduleA/moduleB/README.md | 2 -- .../projects/it-multimodule-0/moduleA/moduleB/build.gradle.kts | 9 +++++++++ .../gradle/projects/it-multimodule-0/moduleA/moduleC/Module.md | 2 ++ .../gradle/projects/it-multimodule-0/moduleA/moduleC/README.md | 2 -- .../projects/it-multimodule-0/moduleA/moduleC/build.gradle.kts | 8 ++++++++ .../projects/it-multimodule-0/moduleA/moduleD/build.gradle.kts | 10 ++++++++++ .../src/main/kotlin/org/jetbrains/dokka/it/moduleD/ModuleC.kt | 6 ++++++ .../gradle/projects/it-multimodule-0/settings.gradle.kts | 1 + 9 files changed, 42 insertions(+), 4 deletions(-) create mode 100644 integration-tests/gradle/projects/it-multimodule-0/moduleA/moduleB/Module.md delete mode 100644 integration-tests/gradle/projects/it-multimodule-0/moduleA/moduleB/README.md create mode 100644 integration-tests/gradle/projects/it-multimodule-0/moduleA/moduleC/Module.md delete mode 100644 integration-tests/gradle/projects/it-multimodule-0/moduleA/moduleC/README.md create mode 100644 integration-tests/gradle/projects/it-multimodule-0/moduleA/moduleD/build.gradle.kts create mode 100644 integration-tests/gradle/projects/it-multimodule-0/moduleA/moduleD/src/main/kotlin/org/jetbrains/dokka/it/moduleD/ModuleC.kt (limited to 'integration-tests/gradle/projects') diff --git a/integration-tests/gradle/projects/it-multimodule-0/moduleA/moduleB/Module.md b/integration-tests/gradle/projects/it-multimodule-0/moduleA/moduleB/Module.md new file mode 100644 index 00000000..0570f467 --- /dev/null +++ b/integration-tests/gradle/projects/it-multimodule-0/moduleA/moduleB/Module.md @@ -0,0 +1,6 @@ +# Module !Module B! +Here is some description for Module B + +Module B: Second paragraph +# Module moduleB +§IGNORED$This documentation shall be ignored, because wrong module name§IGNORED$ diff --git a/integration-tests/gradle/projects/it-multimodule-0/moduleA/moduleB/README.md b/integration-tests/gradle/projects/it-multimodule-0/moduleA/moduleB/README.md deleted file mode 100644 index f8c52880..00000000 --- a/integration-tests/gradle/projects/it-multimodule-0/moduleA/moduleB/README.md +++ /dev/null @@ -1,2 +0,0 @@ -# Module moduleB -Here is some description for module B diff --git a/integration-tests/gradle/projects/it-multimodule-0/moduleA/moduleB/build.gradle.kts b/integration-tests/gradle/projects/it-multimodule-0/moduleA/moduleB/build.gradle.kts index 9492fdc8..5f0b69c7 100644 --- a/integration-tests/gradle/projects/it-multimodule-0/moduleA/moduleB/build.gradle.kts +++ b/integration-tests/gradle/projects/it-multimodule-0/moduleA/moduleB/build.gradle.kts @@ -1,3 +1,5 @@ +import org.jetbrains.dokka.gradle.DokkaTask + plugins { kotlin("jvm") id("org.jetbrains.dokka") @@ -6,3 +8,10 @@ plugins { dependencies { implementation(kotlin("stdlib")) } + +tasks.withType().configureEach { + moduleName.set("!Module B!") + dokkaSourceSets.configureEach { + includes.from("Module.md") + } +} diff --git a/integration-tests/gradle/projects/it-multimodule-0/moduleA/moduleC/Module.md b/integration-tests/gradle/projects/it-multimodule-0/moduleA/moduleC/Module.md new file mode 100644 index 00000000..4ead5671 --- /dev/null +++ b/integration-tests/gradle/projects/it-multimodule-0/moduleA/moduleC/Module.md @@ -0,0 +1,2 @@ +# Module moduleC +Here is some description for module C diff --git a/integration-tests/gradle/projects/it-multimodule-0/moduleA/moduleC/README.md b/integration-tests/gradle/projects/it-multimodule-0/moduleA/moduleC/README.md deleted file mode 100644 index 4ead5671..00000000 --- a/integration-tests/gradle/projects/it-multimodule-0/moduleA/moduleC/README.md +++ /dev/null @@ -1,2 +0,0 @@ -# Module moduleC -Here is some description for module C diff --git a/integration-tests/gradle/projects/it-multimodule-0/moduleA/moduleC/build.gradle.kts b/integration-tests/gradle/projects/it-multimodule-0/moduleA/moduleC/build.gradle.kts index 9492fdc8..e471d375 100644 --- a/integration-tests/gradle/projects/it-multimodule-0/moduleA/moduleC/build.gradle.kts +++ b/integration-tests/gradle/projects/it-multimodule-0/moduleA/moduleC/build.gradle.kts @@ -1,3 +1,5 @@ +import org.jetbrains.dokka.gradle.DokkaTask + plugins { kotlin("jvm") id("org.jetbrains.dokka") @@ -6,3 +8,9 @@ plugins { dependencies { implementation(kotlin("stdlib")) } + +tasks.withType().configureEach { + dokkaSourceSets.configureEach { + includes.from("Module.md") + } +} diff --git a/integration-tests/gradle/projects/it-multimodule-0/moduleA/moduleD/build.gradle.kts b/integration-tests/gradle/projects/it-multimodule-0/moduleA/moduleD/build.gradle.kts new file mode 100644 index 00000000..a16e038f --- /dev/null +++ b/integration-tests/gradle/projects/it-multimodule-0/moduleA/moduleD/build.gradle.kts @@ -0,0 +1,10 @@ +import org.jetbrains.dokka.gradle.DokkaTask + +plugins { + kotlin("jvm") + id("org.jetbrains.dokka") +} + +dependencies { + implementation(kotlin("stdlib")) +} diff --git a/integration-tests/gradle/projects/it-multimodule-0/moduleA/moduleD/src/main/kotlin/org/jetbrains/dokka/it/moduleD/ModuleC.kt b/integration-tests/gradle/projects/it-multimodule-0/moduleA/moduleD/src/main/kotlin/org/jetbrains/dokka/it/moduleD/ModuleC.kt new file mode 100644 index 00000000..88174d53 --- /dev/null +++ b/integration-tests/gradle/projects/it-multimodule-0/moduleA/moduleD/src/main/kotlin/org/jetbrains/dokka/it/moduleD/ModuleC.kt @@ -0,0 +1,6 @@ +package org.jetbrains.dokka.it.moduleD + +@Suppress("unused") +class ModuleD { + fun undocumentedPublicFunction() {} +} diff --git a/integration-tests/gradle/projects/it-multimodule-0/settings.gradle.kts b/integration-tests/gradle/projects/it-multimodule-0/settings.gradle.kts index a5c89291..dda6558f 100644 --- a/integration-tests/gradle/projects/it-multimodule-0/settings.gradle.kts +++ b/integration-tests/gradle/projects/it-multimodule-0/settings.gradle.kts @@ -3,3 +3,4 @@ rootProject.name = "it-multimodule-0" include(":moduleA") include(":moduleA:moduleB") include(":moduleA:moduleC") +include(":moduleA:moduleD") -- cgit