aboutsummaryrefslogtreecommitdiff
path: root/integration/src/main/kotlin/org/jetbrains/dokka/defaultConfiguration.kt
blob: 615f021533dc2c6cdeccf02c180cbe32d7a1a24e (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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
package org.jetbrains.dokka

import kotlinx.serialization.Serializable
import java.io.File
import java.net.URL

@Serializable
data class DokkaConfigurationImpl(
    override val outputDir: String,
    override val format: String,
    override val generateIndexPages: Boolean,
    override val cacheRoot: String?,
    override val impliedPlatforms: List<String>,
    override val passesConfigurations: List<PassConfigurationImpl>
) : DokkaConfiguration

@Serializable
data class PassConfigurationImpl (
    override val moduleName: String,
    override val classpath: List<String>,
    override val sourceRoots: List<SourceRootImpl>,
    override val samples: List<String>,
    override val includes: List<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 sourceLinks: List<SourceLinkDefinitionImpl>,
    override val perPackageOptions: List<PackageOptionsImpl>,
    override var externalDocumentationLinks: List<ExternalDocumentationLinkImpl>,
    override val languageVersion: String?,
    override val apiVersion: String?,
    override val noStdlibLink: Boolean,
    override val noJdkLink: Boolean,
    override val suppressedFiles: List<String>,
    override val collectInheritedExtensionsFromLibraries: Boolean,
    override val analysisPlatform: Platform,
    override val targets: List<String>,
    override val sinceKotlin: String
) : DokkaConfiguration.PassConfiguration

@Serializable
data class SourceRootImpl(
    override val path: String
): DokkaConfiguration.SourceRoot

@Serializable
data class SourceLinkDefinitionImpl(
    override val path: String,
    override val url: String,
    override val lineSuffix: String?
): DokkaConfiguration.SourceLinkDefinition {
    companion object {
        fun parseSourceLinkDefinition(srcLink: String): SourceLinkDefinitionImpl {
            val (path, urlAndLine) = srcLink.split('=')
            return SourceLinkDefinitionImpl(
                File(path).canonicalPath,
                urlAndLine.substringBefore("#"),
                urlAndLine.substringAfter("#", "").let { if (it.isEmpty()) null else "#$it" })
        }
    }
}

@Serializable
data class PackageOptionsImpl(
    override val prefix: String,
    override val includeNonPublic: Boolean,
    override val reportUndocumented: Boolean,
    override val skipDeprecated: Boolean,
    override val suppress: Boolean
): DokkaConfiguration.PackageOptions


@Serializable
data class ExternalDocumentationLinkImpl(@Serializable(with = UrlSerializer::class) override val url: URL,
                                         @Serializable(with = UrlSerializer::class) override val packageListUrl: URL
) : DokkaConfiguration.ExternalDocumentationLink