org.jetbrains.dokka.base.DokkaBaseConfiguration.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dokka-base Show documentation

Dokka is an API documentation engine for Kotlin

There is a newer version: 2.0.0

/*
 * Copyright 2014-2024 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
 */

package org.jetbrains.dokka.base

import org.jetbrains.dokka.plugability.ConfigurableBlock
import java.io.File
import java.time.Year

public data class DokkaBaseConfiguration(
    var customStyleSheets: List = defaultCustomStyleSheets,
    var customAssets: List = defaultCustomAssets,
    var separateInheritedMembers: Boolean = separateInheritedMembersDefault,
    var footerMessage: String = defaultFooterMessage,
    var mergeImplicitExpectActualDeclarations: Boolean = mergeImplicitExpectActualDeclarationsDefault,
    var templatesDir: File? = defaultTemplatesDir,
    var homepageLink: String? = null,
) : ConfigurableBlock {
    public companion object {
        public val defaultFooterMessage: String = "© ${Year.now().value} Copyright"
        public val defaultCustomStyleSheets: List = emptyList()
        public val defaultCustomAssets: List = emptyList()
        public const val separateInheritedMembersDefault: Boolean = false
        public const val mergeImplicitExpectActualDeclarationsDefault: Boolean = false
        public val defaultTemplatesDir: File? = null
    }
}