DokkaModuleDescriptionKxs.kt

/*
 * Copyright 2014-2024 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
 */
package org.jetbrains.dokka.gradle.engine.parameters

import kotlinx.serialization.Serializable
import org.gradle.kotlin.dsl.java
import org.jetbrains.dokka.DokkaConfiguration
import org.jetbrains.dokka.gradle.internal.DokkaInternalApi

/**
 * Any subproject can be merged into a single Dokka Publication. To do this, first it must create
 * a Dokka Module. A [DokkaModuleDescriptionKxs] describes a config file for the Dokka Module that
 * describes its content. This config file will be used by any aggregating project to produce
 * a Dokka Publication with multiple modules.
 *
 * Note: this class implements [java.io.Serializable] because it is used as a
 * [Gradle Property][org.gradle.api.provider.Property], and Gradle must be able to fingerprint
 * property values classes using Java Serialization.
 *
 * All other configuration data classes also implement [java.io.Serializable] via their parent interfaces.
 *
 * @see org.jetbrains.dokka.gradle.engine.parameters.DokkaModuleDescriptionKxs
 * @see org.jetbrains.dokka.DokkaModuleDescriptionImpl
 */
@Serializable
@DokkaInternalApi
data class DokkaModuleDescriptionKxs(
    /** @see DokkaConfiguration.DokkaModuleDescription.name */
    val name: String,
    /** @see [org.gradle.api.Project.getPath] */
    val modulePath: String,
    /** name of the sibling directory that contains the module output */
    val moduleOutputDirName: String = "module",
    /** name of the sibling directory that contains the module includes */
    val moduleIncludesDirName: String = "includes",
)