Re-use includes form child tasks for all modules page generation

3 files changed, 12 insertions, 5 deletions

diff --git a/core/src/main/kotlin/configuration.kt b/core/src/main/kotlin/configuration.kt
index 9a1ff602..b53fd1ee 100644
--- a/core/src/main/kotlin/configuration.kt
+++ b/core/src/main/kotlin/configuration.kt
@@ -61,6 +61,14 @@ fun <T : Any> Iterable<DokkaConfigurationBuilder<T>>.build(): List<T> = this.map
 
 
 data class DokkaSourceSetID(
+    /**
+     * Unique identifier of the scope that this source set is placed in.
+     * Each scope provide only unique source set names.
+     *
+     * E.g. One DokkaTask inside the Gradle plugin represents one source set scope, since there cannot be multiple
+     * source sets with the same name. However, a Gradle project will not be a proper scope, since there can be
+     * multple DokkaTasks that contain source sets with the same name (but different configuration)
+     */
     val scopeId: String,
     val sourceSetName: String
 ) : Serializable {
@@ -116,8 +124,8 @@ interface DokkaConfiguration : Serializable {
 
     interface DokkaModuleDescription : Serializable {
         val name: String
-        val path: File
-        val docFile: File
+        val relativePathToOutputDirectory: File
+        val includes: Set<File>
     }
 
     interface PackageOptions : Serializable {
diff --git a/core/src/main/kotlin/defaultConfiguration.kt b/core/src/main/kotlin/defaultConfiguration.kt
index 3fcc7aac..5b32ebae 100644
--- a/core/src/main/kotlin/defaultConfiguration.kt
+++ b/core/src/main/kotlin/defaultConfiguration.kt
@@ -43,8 +43,8 @@ data class DokkaSourceSetImpl(
 
 data class DokkaModuleDescriptionImpl(
     override val name: String,
-    override val path: File,
-    override val docFile: File
+    override val relativePathToOutputDirectory: File,
+    override val includes: Set<File>
 ) : DokkaConfiguration.DokkaModuleDescription
 
 data class SourceLinkDefinitionImpl(
diff --git a/core/test-api/src/main/kotlin/testApi/testRunner/TestDokkaConfigurationBuilder.kt b/core/test-api/src/main/kotlin/testApi/testRunner/TestDokkaConfigurationBuilder.kt
index f6cb99db..2d9f99b2 100644
--- a/core/test-api/src/main/kotlin/testApi/testRunner/TestDokkaConfigurationBuilder.kt
+++ b/core/test-api/src/main/kotlin/testApi/testRunner/TestDokkaConfigurationBuilder.kt
@@ -138,7 +138,6 @@ val defaultSourceSet = DokkaSourceSetImpl(
     analysisPlatform = Platform.DEFAULT
 )
 
-// TODO NOW: Clean up
 fun sourceSet(name: String): DokkaConfiguration.DokkaSourceSet {
     return defaultSourceSet.copy(
         displayName = name,