aboutsummaryrefslogtreecommitdiff
path: root/core/src/main/kotlin/configuration.kt
diff options
context:
space:
mode:
authorsebastian.sellmair <sebastian.sellmair@jetbrains.com>2020-08-28 11:28:54 +0200
committerSebastian Sellmair <34319766+sellmair@users.noreply.github.com>2020-08-31 15:10:04 +0200
commit02ccae10e3f717c330dae5d87b49a0e72f798905 (patch)
tree4c63d6039fdc5a20c065724e672adbc5c6a3a0e5 /core/src/main/kotlin/configuration.kt
parent8cd28416817dfd7d28bb66b28e849d97cc09012b (diff)
downloaddokka-02ccae10e3f717c330dae5d87b49a0e72f798905.tar.gz
dokka-02ccae10e3f717c330dae5d87b49a0e72f798905.tar.bz2
dokka-02ccae10e3f717c330dae5d87b49a0e72f798905.zip
Re-use includes form child tasks for all modules page generation
Diffstat (limited to 'core/src/main/kotlin/configuration.kt')
-rw-r--r--core/src/main/kotlin/configuration.kt12
1 files changed, 10 insertions, 2 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 {