aboutsummaryrefslogtreecommitdiff
path: root/integration/src/main/kotlin/org/jetbrains/dokka/configuration.kt
blob: 5d10f6d217408bcd37845d64f8c52f8ef871e4b8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
package org.jetbrains.dokka


interface DokkaConfiguration {
    val moduleName: String
    val classpath: List<String>
    val sourceRoots: List<SourceRoot>
    val samples: List<String>
    val includes: List<String>
    val outputDir: String
    val format: String
    val includeNonPublic: Boolean
    val includeRootPackage: Boolean
    val reportUndocumented: Boolean
    val skipEmptyPackages: Boolean
    val skipDeprecated: Boolean
    val jdkVersion: Int
    val generateIndexPages: Boolean
    val sourceLinks: List<SourceLinkDefinition>
    val impliedPlatforms: List<String>
    val perPackageOptions: List<PackageOptions>

    interface SourceRoot {
        val path: String
        val platforms: List<String>
    }

    interface SourceLinkDefinition {
        val path: String
        val url: String
        val lineSuffix: String?
    }

    interface PackageOptions {
        val prefix: String
        val includeNonPublic: Boolean
        val reportUndocumented: Boolean
        val skipDeprecated: Boolean
    }
}

data class SerializeOnlyDokkaConfiguration(override val moduleName: String,
                                           override val classpath: List<String>,
                                           override val sourceRoots: List<DokkaConfiguration.SourceRoot>,
                                           override val samples: List<String>,
                                           override val includes: List<String>,
                                           override val outputDir: String,
                                           override val format: String,
                                           override val includeNonPublic: Boolean,
                                           override val includeRootPackage: Boolean,
                                           override val reportUndocumented: Boolean,
                                           override val skipEmptyPackages: Boolean,
                                           override val skipDeprecated: Boolean,
                                           override val jdkVersion: Int,
                                           override val generateIndexPages: Boolean,
                                           override val sourceLinks: List<DokkaConfiguration.SourceLinkDefinition>,
                                           override val impliedPlatforms: List<String>,
                                           override val perPackageOptions: List<DokkaConfiguration.PackageOptions>) : DokkaConfiguration