Implement dokka-multimodule-example

Author: sellmair

gradle/dokka/dokka-multimodule-example/Module.md

@@ -4,10 +4,4 @@ subprojects {
         jcenter()
         maven("https://dl.bintray.com/kotlin/kotlin-dev")
     }
-
-    dependencies {
-        implementation(kotlin("stdlib"))
-        testImplementation(kotlin("test-junit"))
-    }
 }
-

gradle/dokka/dokka-multimodule-example/build.gradle.kts

@@ -3,3 +3,15 @@ plugins {
     id("org.jetbrains.dokka")
 }
 
+dependencies {
+    implementation(kotlin("stdlib"))
+}
+
+/**
+ * Configuring the html multimodule task
+ * Run ./gradlew :parentProject:dokkaHtmlMultimodule dokkaHtml
+ */
+tasks.dokkaHtmlMultimodule {
+    documentationFileName = "Module.md"
+}
+

gradle/dokka/dokka-multimodule-example/parentProject/build.gradle.kts

@@ -0,0 +1,5 @@
+# Module ChildModuleA
+This is the child module a
+
+# Package demo
+This package contains a few examples of Dokka usage.

gradle/dokka/dokka-multimodule-example/parentProject/childProjectA/Module.md

@@ -1,4 +1,18 @@
+import org.jetbrains.dokka.gradle.DokkaTask
+
 plugins {
     kotlin("jvm")
     id("org.jetbrains.dokka")
 }
+
+dependencies {
+    implementation(kotlin("stdlib"))
+}
+
+tasks.withType<DokkaTask> {
+    dokkaSourceSets {
+        configureEach {
+            includes = listOf("Module.md")
+        }
+    }
+}

gradle/dokka/dokka-multimodule-example/parentProject/childProjectA/build.gradle.kts

@@ -0,0 +1,8 @@
+@file:Suppress("unused")
+
+package demo
+
+/**
+ * Class defined in child project a
+ */
+class ChildProjectAClass

gradle/dokka/dokka-multimodule-example/parentProject/childProjectA/src/main/kotlin/demo/ChildProjectAClass.kt

@@ -0,0 +1,5 @@
+# Module ChildModuleB
+This is the child module b
+
+# Package demo
+This package contains a few examples of Dokka usage.

gradle/dokka/dokka-multimodule-example/parentProject/childProjectB/Module.md

@@ -1,4 +1,18 @@
+import org.jetbrains.dokka.gradle.DokkaTask
+
 plugins {
     kotlin("jvm")
     id("org.jetbrains.dokka")
 }
+
+dependencies {
+    implementation(kotlin("stdlib"))
+}
+
+tasks.withType<DokkaTask> {
+    dokkaSourceSets {
+        configureEach {
+            includes = listOf("Module.md")
+        }
+    }
+}

gradle/dokka/dokka-multimodule-example/parentProject/childProjectB/build.gradle.kts

@@ -0,0 +1,8 @@
+@file:Suppress("unused")
+
+package demo
+
+/**
+ * Class defined in child module b
+ */
+class ChildProjectBClass

gradle/dokka/dokka-multimodule-example/parentProject/childProjectB/src/main/kotlin/demo/ChildProjectBClass.kt

@@ -11,5 +11,9 @@ pluginManagement {
     }
 }
 
+include(":parentProject")
+include(":parentProject:childProjectA")
+include(":parentProject:childProjectB")
+
 rootProject.name = "dokka-multimodule-example"