@file:Suppress("FunctionName") package org.jetbrains.dokka import org.jetbrains.dokka.plugability.ConfigurableBlock import org.jetbrains.dokka.utilities.parseJson import org.jetbrains.dokka.utilities.toJsonString import java.io.File import java.io.Serializable import java.net.URL object DokkaDefaults { val moduleName: String = "root" val outputDir = File("./dokka") const val format: String = "html" val cacheRoot: File? = null const val offlineMode: Boolean = false const val failOnWarning: Boolean = false const val delayTemplateSubstitution: Boolean = false const val includeNonPublic: Boolean = false const val reportUndocumented: Boolean = false const val skipEmptyPackages: Boolean = true const val skipDeprecated: Boolean = false const val jdkVersion: Int = 8 const val noStdlibLink: Boolean = false const val noJdkLink: Boolean = false val analysisPlatform: Platform = Platform.DEFAULT const val suppress: Boolean = false const val sourceSetDisplayName = "JVM" const val sourceSetName = "main" val moduleVersion: String? = null val pluginsConfiguration = mutableListOf() const val suppressObviousFunctions = true const val suppressInheritedMembers = false } enum class Platform(val key: String) { jvm("jvm"), js("js"), native("native"), common("common"); companion object { val DEFAULT = jvm fun fromString(key: String): Platform { return when (key.toLowerCase()) { jvm.key -> jvm js.key -> js native.key -> native common.key -> common "androidjvm", "android" -> jvm "metadata" -> common else -> throw IllegalArgumentException("Unrecognized platform: $key") } } } } interface DokkaConfigurationBuilder { fun build(): T } fun Iterable>.build(): List = this.map { it.build() } 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 { override fun toString(): String { return "$scopeId/$sourceSetName" } } fun DokkaConfigurationImpl(json: String): DokkaConfigurationImpl = parseJson(json) fun DokkaConfiguration.toJsonString(): String = toJsonString(this) fun T.toJsonString(): String = toJsonString(this) interface DokkaConfiguration : Serializable { val moduleName: String val moduleVersion: String? val outputDir: File val cacheRoot: File? val offlineMode: Boolean val failOnWarning: Boolean val sourceSets: List val modules: List val pluginsClasspath: List val pluginsConfiguration: List val delayTemplateSubstitution: Boolean val suppressObviousFunctions: Boolean val includes: Set val suppressInheritedMembers: Boolean enum class SerializationFormat : Serializable { JSON, XML } interface PluginConfiguration : Serializable { val fqPluginName: String val serializationFormat: SerializationFormat val values: String } interface DokkaSourceSet : Serializable { val sourceSetID: DokkaSourceSetID val displayName: String val classpath: List val sourceRoots: Set val dependentSourceSets: Set val samples: Set val includes: Set val includeNonPublic: Boolean val reportUndocumented: Boolean val skipEmptyPackages: Boolean val skipDeprecated: Boolean val jdkVersion: Int val sourceLinks: Set val perPackageOptions: List val externalDocumentationLinks: Set val languageVersion: String? val apiVersion: String? val noStdlibLink: Boolean val noJdkLink: Boolean val suppressedFiles: Set val analysisPlatform: Platform } interface SourceLinkDefinition : Serializable { val localDirectory: String val remoteUrl: URL val remoteLineSuffix: String? } interface DokkaModuleDescription : Serializable { val name: String val relativePathToOutputDirectory: File val sourceOutputDirectory: File val includes: Set } interface PackageOptions : Serializable { val matchingRegex: String val includeNonPublic: Boolean val reportUndocumented: Boolean? val skipDeprecated: Boolean val suppress: Boolean } interface ExternalDocumentationLink : Serializable { val url: URL val packageListUrl: URL companion object } } fun ExternalDocumentationLink( url: URL? = null, packageListUrl: URL? = null ): ExternalDocumentationLinkImpl { return if (packageListUrl != null && url != null) ExternalDocumentationLinkImpl(url, packageListUrl) else if (url != null) ExternalDocumentationLinkImpl(url, URL(url, "package-list")) else throw IllegalArgumentException("url or url && packageListUrl must not be null for external documentation link") } fun ExternalDocumentationLink( url: String, packageListUrl: String? = null ): ExternalDocumentationLinkImpl = ExternalDocumentationLink(url.let(::URL), packageListUrl?.let(::URL))