Dokka Gradle 설정 옵션

Dokka는 사용자 및 독자의 경험을 맞춤화할 수 있는 다양한 설정 옵션을 제공합니다.

아래는 각 설정 섹션에 대한 자세한 설명과 몇 가지 예시입니다. 모든 설정 옵션이 적용된 예시도 확인할 수 있습니다.

단일 프로젝트 및 멀티 프로젝트 빌드에 설정 블록을 적용하는 방법에 대한 자세한 내용은 설정 예시를 참조하세요.

일반 설정 (General configuration)

다음은 일반적인 Dokka Gradle 플러그인 설정 예시입니다:

최상위 dokka {} DSL 설정을 사용합니다.
DGP에서 Dokka 발행(publication) 설정은 dokkaPublications{} 블록에서 선언합니다.
기본 발행 형식은 html 및 javadoc입니다.
Gradle의 Kotlin DSL은 타입 안전 접근자(type-safe accessors)를 사용하기 때문에 build.gradle.kts 파일의 구문은 일반적인 .kt 파일(Kotlin 커스텀 플러그인 등에 사용되는 파일)과 다릅니다.

Gradle Kotlin DSLKotlin custom pluginGradle Groovy DSL

kotlin

plugins {
    id("org.jetbrains.dokka") version "2.1.0"
}

dokka {
    dokkaPublications.html {
        moduleName.set(project.name)
        moduleVersion.set(project.version.toString())
        // HTML 문서의 표준 출력 디렉터리
        outputDirectory.set(layout.buildDirectory.dir("dokka/html"))
        failOnWarning.set(false)
        suppressInheritedMembers.set(false)
        suppressObviousFunctions.set(true)
        offlineMode.set(false)
        includes.from("packages.md", "extra.md")
        
        // 추가 파일들을 위한 출력 디렉터리
        // 출력 디렉터리를 변경하고 추가 파일을 포함하려는 경우 
        // 표준 블록 대신 이 블록을 사용하세요.
        outputDirectory.set(rootDir.resolve("docs/api/0.x"))
        
        // fileTree를 사용하여 여러 파일 추가
        includes.from(
            fileTree("docs") {
                include("**/*.md")
            }
        )
    }
}

파일 작업에 대한 자세한 내용은 Gradle 문서를 참조하세요.

kotlin

// CustomPlugin.kt

import org.gradle.api.Plugin
import org.gradle.api.Project
import org.jetbrains.dokka.gradle.DokkaExtension

abstract class CustomPlugin : Plugin<Project> {
    override fun apply(project: Project) {
        project.plugins.apply("org.jetbrains.dokka")

        project.extensions.configure(DokkaExtension::class.java) { dokka ->
            
            dokka.moduleName.set(project.name)
            dokka.moduleVersion.set(project.version.toString())

            dokka.dokkaPublications.named("html") { publication ->
                // HTML 문서의 표준 출력 디렉터리
                publication.outputDirectory.set(project.layout.buildDirectory.dir("dokka/html"))
                publication.failOnWarning.set(true)
                publication.suppressInheritedMembers.set(true)
                publication.offlineMode.set(false)
                publication.suppressObviousFunctions.set(true)
                publication.includes.from("packages.md", "extra.md")

                // 추가 파일들을 위한 출력 디렉터리
                // 출력 디렉터리를 변경하고 추가 파일을 포함하려는 경우 
                // 표준 블록 대신 이 블록을 사용하세요.
                html.outputDirectory.set(project.rootDir.resolve("docs/api/0.x"))
            }
        }
    }
}

groovy

plugins {
    id 'org.jetbrains.dokka' version '2.1.0'
}

dokka {
    dokkaPublications {
        html {
            // 일반 모듈 정보 설정
            moduleName.set(project.name)
            moduleVersion.set(project.version.toString())

            // HTML 문서의 표준 출력 디렉터리
            outputDirectory.set(layout.buildDirectory.dir("dokka/html"))

            // 핵심 Dokka 옵션
            failOnWarning.set(false)
            suppressInheritedMembers.set(false)
            suppressObviousFunctions.set(true)
            offlineMode.set(false)
            includes.from(files("packages.md", "extra.md"))

            // 추가 파일들을 위한 출력 디렉터리
            // 출력 디렉터리를 변경하고 추가 파일을 포함하려는 경우 
            // 표준 블록 대신 이 블록을 사용하세요.
            outputDirectory.set(file("$rootDir/docs/api/0.x"))
        }
    }
}

moduleName

프로젝트 문서의 표시 이름입니다. 목차, 네비게이션, 헤더 및 로그 메시지에 나타납니다. 멀티 프로젝트 빌드에서 각 하위 프로젝트의 moduleName은 집계된 문서에서 해당 섹션의 제목으로 사용됩니다.

기본값: Gradle 프로젝트 이름

moduleVersion

생성된 문서에 표시되는 하위 프로젝트 버전입니다. 단일 프로젝트 빌드에서는 프로젝트 버전으로 사용됩니다. 멀티 프로젝트 빌드에서는 문서를 집계할 때 각 하위 프로젝트의 moduleVersion이 사용됩니다.

기본값: Gradle 프로젝트 버전

outputDirectory

생성된 문서가 저장되는 디렉터리입니다.

이 설정은 dokkaGenerate 태스크에 의해 생성되는 모든 문서 형식(HTML, Javadoc 등)에 적용됩니다.

기본값: build/dokka/html

추가 파일들을 위한 출력 디렉터리

단일 및 멀티 프로젝트 빌드 모두에 대해 출력 디렉터리를 지정하고 추가 파일을 포함할 수 있습니다. 멀티 프로젝트 빌드의 경우, 루트 프로젝트의 설정에서 출력 디렉터리를 설정하고 추가 파일을 포함하세요.

failOnWarning

문서 생성 중에 경고(warning)가 발생했을 때 Dokka가 빌드를 실패 처리할지 여부를 결정합니다. 프로세스는 모든 오류와 경고가 먼저 출력될 때까지 기다립니다.

이 설정은 reportUndocumented와 함께 사용하면 효과적입니다.

기본값: false

suppressInheritedMembers

주어진 클래스에서 명시적으로 오버라이드되지 않은 상속된 멤버를 억제할지 여부입니다.

참고: 이 옵션은 equals, hashCode, toString과 같은 함수를 억제하지만, dataClass.componentN 및 dataClass.copy와 같은 합성 함수(synthetic functions)는 억제하지 않습니다. 해당 함수들을 억제하려면 suppressObviousFunctions를 사용하세요.

기본값: false

suppressObviousFunctions

명백한(obvious) 함수들을 억제할지 여부입니다.

다음과 같은 경우 함수가 명백한 것으로 간주됩니다:

kotlin.Any, Kotlin.Enum, java.lang.Object 또는 java.lang.Enum으로부터 상속된 함수(예: equals, hashCode, toString).
합성 함수(컴파일러에 의해 생성됨)이면서 문서가 없는 함수(예: dataClass.componentN 또는 dataClass.copy).

기본값: true

offlineMode

네트워크를 통해 원격 파일 및 링크를 확인할지 여부입니다.

여기에는 외부 문서에 대한 링크를 생성하는 데 사용되는 패키지 리스트(package-lists)가 포함됩니다. 예를 들어, 이를 통해 표준 라이브러리의 클래스들을 문서에서 클릭 가능하게 만들 수 있습니다.

이 옵션을 true로 설정하면 특정 상황에서 빌드 시간을 크게 단축할 수 있지만, 사용자 경험이 저하될 수도 있습니다. 예를 들어, 표준 라이브러리를 포함한 의존성의 클래스 및 멤버 링크를 확인할 수 없게 됩니다.

참고: 가져온 파일을 로컬에 캐시하고 Dokka에 로컬 경로로 제공할 수 있습니다. externalDocumentationLinks 섹션을 참조하세요.

기본값: false

includes

하위 프로젝트 및 패키지 문서를 포함하는 마크다운 파일 리스트입니다. 마크다운 파일은 필수 형식과 일치해야 합니다.

지정된 파일의 내용은 파싱되어 하위 프로젝트 및 패키지 설명으로 문서에 포함됩니다.

문서의 모습과 사용 방법은 Dokka Gradle 예시를 참조하세요.

소스 세트 설정 (Source set configuration)

Dokka를 사용하면 Kotlin 소스 세트에 대한 일부 옵션을 설정할 수 있습니다:

Gradle Kotlin DSLGradle Groovy DSL

kotlin

import org.jetbrains.dokka.gradle.engine.parameters.VisibilityModifier

dokka {
    // ..
    // 일반 설정 섹션
    // ..

    // 소스 세트 설정
    dokkaSourceSets {
        // 예: 'linux' 소스 세트에만 적용되는 설정
        named("linux") {
            dependentSourceSets{named("native")}
            sourceRoots.from(file("linux/src"))
        }

        configureEach {
            suppress.set(false)
            displayName.set(name)
            documentedVisibilities.set(setOf(VisibilityModifier.Public)) // 또는 documentedVisibilities(VisibilityModifier.Public)
            reportUndocumented.set(false)
            skipEmptyPackages.set(true)
            skipDeprecated.set(false)
            suppressGeneratedFiles.set(true)
            jdkVersion.set(8)
            languageVersion.set("1.7")
            apiVersion.set("1.7")
            sourceRoots.from(file("src"))
            classpath.from(file("libs/dependency.jar"))
            samples.from("samples/Basic.kt", "samples/Advanced.kt")
           
            sourceLink {
                // 소스 링크 섹션
            }
            perPackageOption {
                // 패키지 옵션 섹션
            }
            externalDocumentationLinks {
                // 외부 문서 링크 섹션
            }
        }
    }
}

groovy

import org.jetbrains.dokka.gradle.engine.parameters.VisibilityModifier

dokka {
    // ..
    // 일반 설정 섹션
    // ..

    dokkaSourceSets {
        // 예: 'linux' 소스 세트에만 적용되는 설정
        named("linux") {
            dependentSourceSets { named("native") }
            sourceRoots.from(file("linux/src"))
        }

        configureEach {
            suppress.set(false)
            displayName.set(name)
            documentedVisibilities.set([VisibilityModifier.Public] as Set) // 또는 documentedVisibilities(VisibilityModifier.Public)
            reportUndocumented.set(false)
            skipEmptyPackages.set(true)
            skipDeprecated.set(false)
            suppressGeneratedFiles.set(true)
            jdkVersion.set(8)
            languageVersion.set("1.7")
            apiVersion.set("1.7")
            sourceRoots.from(file("src"))
            classpath.from(file("libs/dependency.jar"))
            samples.from("samples/Basic.kt", "samples/Advanced.kt")

            sourceLink {
                // 소스 링크 섹션
            }
            perPackageOption {
                // 패키지 옵션 섹션
            }
            externalDocumentationLinks {
                // 외부 문서 링크 섹션
            }
        }
    }
}

suppress

문서 생성 시 이 소스 세트를 건너뛸지 여부입니다.

기본값: false

displayName

이 소스 세트를 참조할 때 사용되는 표시 이름입니다.

이 이름은 외부적(예: 문서 독자에게 보이는 소스 세트 이름)으로나 내부적(예: reportUndocumented의 로그 메시지)으로 모두 사용됩니다.

기본적으로 이 값은 Kotlin Gradle 플러그인에서 제공하는 정보로부터 추론됩니다.

documentedVisibilities

생성된 문서에 포함할 가시성 수정자(visibility modifiers)를 정의합니다.

protected, internal, private 선언을 문서화하고 싶거나, 반대로 public 선언을 제외하고 내부 API만 문서화하고 싶을 때 사용합니다.

또한 Dokka의 documentedVisibilities() 함수를 사용하여 문서화할 가시성을 추가할 수 있습니다.

이는 각 개별 패키지에 대해 설정할 수 있습니다.

기본값: VisibilityModifier.Public

reportUndocumented

표시되는 선언 중 문서화되지 않은 것(즉, documentedVisibilities 및 기타 필터에 의해 필터링된 후 KDoc이 없는 선언)에 대해 경고를 출력할지 여부입니다.

이 설정은 failOnWarning과 함께 사용하면 효과적입니다.

이는 각 개별 패키지에 대해 설정할 수 있습니다.

기본값: false

skipEmptyPackages

다양한 필터가 적용된 후 표시되는 선언이 없는 패키지를 건너뛸지 여부입니다.

예를 들어, skipDeprecated가 true로 설정되어 있고 패키지에 지원 중단된(deprecated) 선언만 포함된 경우, 해당 패키지는 비어 있는 것으로 간주됩니다.

기본값: true

skipDeprecated

@Deprecated 어노테이션이 달린 선언을 문서화할지 여부입니다.

이는 각 개별 패키지에 대해 설정할 수 있습니다.

기본값: false

suppressGeneratedFiles

생성된 파일(generated files)을 문서화할지 여부입니다.

생성된 파일은 {project}/{buildDir}/generated 디렉터리 아래에 있을 것으로 예상됩니다.

이 옵션을 true로 설정하면 해당 디렉터리의 모든 파일이 suppressedFiles 옵션에 효과적으로 추가되므로 수동으로 설정할 수도 있습니다.

기본값: true

suppressAnnotatedWith

특정 어노테이션이 달린 선언을 억제하기 위한 어노테이션 정규화된 이름(FQNs) 세트입니다.

이 어노테이션들 중 하나가 달린 모든 선언은 생성된 문서에서 제외됩니다.

jdkVersion

Java 타입에 대한 외부 문서 링크를 생성할 때 사용할 JDK 버전입니다.

예를 들어, 공용 선언 시그니처에서 java.util.UUID를 사용하고 이 옵션이 8로 설정된 경우, Dokka는 이에 대해 JDK 8 Javadoc으로 연결되는 외부 문서 링크를 생성합니다.

기본값: 8

languageVersion

분석 및 @sample 환경을 설정하는 데 사용되는 Kotlin 언어 버전입니다.

기본적으로 Dokka의 내장 컴파일러에서 사용 가능한 최신 언어 버전이 사용됩니다.

apiVersion

분석 및 @sample 환경을 설정하는 데 사용되는 Kotlin API 버전입니다.

기본적으로 languageVersion으로부터 추론됩니다.

sourceRoots

분석 및 문서화할 소스 코드 루트입니다. 디렉터리와 개별 .kt 및 .java 파일을 입력으로 받을 수 있습니다.

기본적으로 소스 루트는 Kotlin Gradle 플러그인에서 제공하는 정보로부터 추론됩니다.

classpath

분석 및 대화형 샘플을 위한 클래스패스입니다.

의존성에서 가져온 일부 타입이 자동으로 확인되지 않거나 선택되지 않을 때 유용합니다.

이 옵션은 .jar 및 .klib 파일을 모두 허용합니다.

기본적으로 클래스패스는 Kotlin Gradle 플러그인에서 제공하는 정보로부터 추론됩니다.

samples

@sample KDoc 태그를 통해 참조되는 샘플 함수들을 포함하는 디렉터리 또는 파일 리스트입니다.

소스 링크 설정 (Source link configuration)

독자가 원격 저장소에서 각 선언의 소스를 찾을 수 있도록 소스 링크를 설정합니다. 이 설정에는 dokkaSourceSets.main {} 블록을 사용합니다.

sourceLinks {} 설정 블록을 사용하면 특정 라인 번호가 포함된 remoteUrl로 연결되는 source 링크를 각 시그니처에 추가할 수 있습니다. 라인 번호는 remoteLineSuffix를 설정하여 구성할 수 있습니다.

예시는 kotlinx.coroutines의 count() 함수 문서를 참조하세요.

Gradle의 Kotlin DSL은 타입 안전 접근자를 사용하기 때문에 build.gradle.kts 파일의 구문은 일반적인 .kt 파일(커스텀 Gradle 플러그인 등에 사용되는 파일)과 다릅니다:

Gradle Kotlin DSLKotlin custom pluginGradle Groovy DSL

kotlin

// build.gradle.kts

dokka {
    dokkaSourceSets.main {
        sourceLink {
            localDirectory.set(file("src/main/kotlin"))
            remoteUrl("https://github.com/your-repo")
            remoteLineSuffix.set("#L")
        }
    }
}

kotlin

// CustomPlugin.kt

import org.gradle.api.Plugin
import org.gradle.api.Project
import org.jetbrains.dokka.gradle.DokkaExtension

abstract class CustomPlugin : Plugin<Project> {
    override fun apply(project: Project) {
        project.plugins.apply("org.jetbrains.dokka")
        project.extensions.configure(DokkaExtension::class.java) { dokka ->
            dokka.dokkaSourceSets.named("main") { dss ->
                dss.includes.from("README.md")
                dss.sourceLink {
                    it.localDirectory.set(project.file("src/main/kotlin"))
                    it.remoteUrl("https://example.com/src")
                    it.remoteLineSuffix.set("#L")
                }
            }
        }
    }
}

groovy

dokka {
    dokkaSourceSets {
        main {
            sourceLink {
                localDirectory.set(file("src/main/kotlin"))
                remoteUrl.set(new URI("https://github.com/your-repo"))
                remoteLineSuffix.set("#L")
            }
        }
    }
}

localDirectory

로컬 소스 디렉터리의 경로입니다. 경로는 현재 프로젝트의 루트에 대한 상대 경로여야 합니다.

remoteUrl

GitHub, GitLab, Bitbucket 또는 소스 파일에 대한 안정적인 URL을 제공하는 호스팅 서비스와 같이 문서 독자가 액세스할 수 있는 소스 코드 호스팅 서비스의 URL입니다. 이 URL은 선언의 소스 코드 링크를 생성하는 데 사용됩니다.

remoteLineSuffix

URL에 소스 코드 라인 번호를 추가하는 데 사용되는 접미사입니다. 이를 통해 독자는 파일뿐만 아니라 선언의 특정 라인 번호로 이동할 수 있습니다.

지정된 접미사 뒤에 번호 자체가 추가됩니다. 예를 들어, 이 옵션이 #L로 설정되어 있고 라인 번호가 10인 경우, 결과 URL 접미사는 #L10이 됩니다.

주요 서비스에서 사용되는 접미사:

GitHub: #L
GitLab: #L
Bitbucket: #lines-

기본값: #L

패키지 옵션 (Package options)

perPackageOption 설정 블록을 사용하면 matchingRegex와 일치하는 특정 패키지에 대해 일부 옵션을 설정할 수 있습니다:

Gradle Kotlin DSLGradle Groovy DSL

kotlin

import org.jetbrains.dokka.gradle.engine.parameters.VisibilityModifier

dokka {
    dokkaPublications.html {
        dokkaSourceSets.configureEach {
            perPackageOption {
                matchingRegex.set(".*api.*")
                suppress.set(false)
                skipDeprecated.set(false)
                reportUndocumented.set(false)
                documentedVisibilities.set(setOf(VisibilityModifier.Public)) // 또는 documentedVisibilities(VisibilityModifier.Public)
            }
        }
    }
}

groovy

import org.jetbrains.dokka.gradle.engine.parameters.VisibilityModifier

dokka {
    dokkaPublications {
        html {
            dokkaSourceSets.configureEach {
                perPackageOption {
                    matchingRegex.set(".*api.*")
                    suppress.set(false)
                    skipDeprecated.set(false)
                    reportUndocumented.set(false)
                    documentedVisibilities.set([VisibilityModifier.Public] as Set)
                }
            }
        }
    }
}

matchingRegex

패키지를 일치시키는 데 사용되는 정규식입니다.

기본값: .*

suppress

문서 생성 시 해당 패키지를 건너뛸지 여부입니다.

기본값: false

skipDeprecated

@Deprecated 어노테이션이 달린 선언을 문서화할지 여부입니다.

이는 소스 세트 수준에서도 설정할 수 있습니다.

기본값: false

reportUndocumented

표시되는 선언 중 문서화되지 않은 것(즉, documentedVisibilities 및 기타 필터에 의해 필터링된 후 KDoc이 없는 선언)에 대해 경고를 출력할지 여부입니다.

이 설정은 failOnWarning과 함께 사용하면 효과적입니다.

이는 소스 세트 수준에서도 설정할 수 있습니다.

기본값: false

documentedVisibilities

생성된 문서에 포함할 가시성 수정자를 정의합니다.

이 패키지 내의 protected, internal, private 선언을 문서화하고 싶거나, 반대로 public 선언을 제외하고 내부 API만 문서화하고 싶을 때 사용합니다.

또한 Dokka의 documentedVisibilities() 함수를 사용하여 문서화할 가시성을 추가할 수 있습니다.

이는 소스 세트 수준에서도 설정할 수 있습니다.

기본값: VisibilityModifier.Public

외부 문서 링크 설정 (External documentation links configuration)

externalDocumentationLinks {} 블록을 사용하면 의존성의 외부에 호스팅된 문서로 연결되는 링크를 생성할 수 있습니다.

예를 들어, kotlinx.serialization의 타입을 사용하는 경우, 기본적으로 문서에서 클릭할 수 없으며 해결되지 않은 것처럼 보입니다. 하지만 kotlinx.serialization의 API 참조 문서는 Dokka로 빌드되었고 kotlinlang.org에 게시되어 있으므로, 이에 대한 외부 문서 링크를 설정할 수 있습니다. 이를 통해 Dokka는 해당 라이브러리의 타입에 대한 링크를 생성하여 성공적으로 해결되고 클릭 가능하게 만들 수 있습니다.

기본적으로 Kotlin 표준 라이브러리, JDK, Android SDK 및 AndroidX에 대한 외부 문서 링크가 설정되어 있습니다.

register() 메서드를 사용하여 각 링크를 정의하고 외부 문서 링크를 등록합니다. externalDocumentationLinks API는 Gradle DSL 규칙에 맞춰 이 메서드를 사용합니다:

Gradle Kotlin DSLGradle Groovy DSL

kotlin

dokka {
    dokkaSourceSets.configureEach {
        externalDocumentationLinks.register("example-docs") {
            url("https://example.com/docs/")
            packageListUrl("https://example.com/docs/package-list")
        }
    }
}

groovy

dokka {
    dokkaSourceSets.configureEach {
        externalDocumentationLinks.register("example-docs") {
            url.set(new URI("https://example.com/docs/"))
            packageListUrl.set(new URI("https://example.com/docs/package-list"))
        }
    }
}

url

연결할 문서의 루트 URL입니다. 반드시 마지막에 슬래시(/)가 포함되어야 합니다.

Dokka는 지정된 URL에서 package-list를 자동으로 찾고 선언들을 서로 연결하기 위해 최선을 다합니다.

자동 해결이 실패하거나 로컬에 캐시된 파일을 대신 사용하려는 경우, packageListUrl 옵션 설정을 고려하세요.

packageListUrl

package-list의 정확한 위치입니다. 이는 Dokka의 자동 해결 기능에 의존하는 대신 사용할 수 있는 대안입니다.

패키지 리스트에는 하위 프로젝트 및 패키지 이름과 같은 문서 및 프로젝트 자체에 대한 정보가 포함되어 있습니다.

네트워크 호출을 피하기 위해 로컬에 캐시된 파일이 될 수도 있습니다.

전체 설정 (Complete configuration)

아래는 가능한 모든 설정 옵션이 한꺼번에 적용된 예시입니다:

Gradle Kotlin DSLGradle Groovy DSL

kotlin

import org.jetbrains.dokka.gradle.engine.parameters.VisibilityModifier

plugins {
    id("org.jetbrains.dokka") version "2.1.0"
}

dokka {
    dokkaPublications.html {
        moduleName.set(project.name)
        moduleVersion.set(project.version.toString())
        outputDirectory.set(layout.buildDirectory.dir("dokka/html"))
        failOnWarning.set(false)
        suppressInheritedMembers.set(false)
        suppressObviousFunctions.set(true)
        offlineMode.set(false)
        includes.from("packages.md", "extra.md")
   }

    dokkaSourceSets {
        // 예: 'linux' 소스 세트에만 적용되는 설정
        named("linux") {
            dependentSourceSets{named("native")}
            sourceRoots.from(file("linux/src"))
        }

        configureEach {
            suppress.set(false)
            displayName.set(name)
            documentedVisibilities.set(setOf(VisibilityModifier.Public)) // 또는 documentedVisibilities(VisibilityModifier.Public)
            reportUndocumented.set(false)
            skipEmptyPackages.set(true)
            skipDeprecated.set(false)
            suppressGeneratedFiles.set(true)
            jdkVersion.set(8)
            languageVersion.set("1.7")
            apiVersion.set("1.7")
            sourceRoots.from(file("src"))
            classpath.from(file("libs/dependency.jar"))
            samples.from("samples/Basic.kt", "samples/Advanced.kt")

            sourceLink {
                localDirectory.set(file("src/main/kotlin"))
                remoteUrl("https://example.com/src")
                remoteLineSuffix.set("#L")
            }

            externalDocumentationLinks {
                url = URL("https://example.com/docs/")
                packageListUrl = File("/path/to/package-list").toURI().toURL()
            }

            perPackageOption {
                matchingRegex.set(".*api.*")
                suppress.set(false)
                skipDeprecated.set(false)
                reportUndocumented.set(false)
                documentedVisibilities.set(
                    setOf(
                        VisibilityModifier.Public,
                        VisibilityModifier.Private,
                        VisibilityModifier.Protected,
                        VisibilityModifier.Internal,
                        VisibilityModifier.Package
                    )
                )
            }
        }
    }
}

groovy

import org.jetbrains.dokka.gradle.engine.parameters.VisibilityModifier

plugins {
    id 'org.jetbrains.dokka' version '2.1.0'
}

dokka {
    dokkaPublications {
        html {
            moduleName.set(project.name)
            moduleVersion.set(project.version.toString())
            outputDirectory.set(layout.buildDirectory.dir("dokka/html"))
            failOnWarning.set(false)
            suppressInheritedMembers.set(false)
            suppressObviousFunctions.set(true)
            offlineMode.set(false)
            includes.from("packages.md", "extra.md")
        }
    }

    dokkaSourceSets {
        // 예: 'linux' 소스 세트에만 적용되는 설정
        named("linux") {
            dependentSourceSets { named("native") }
            sourceRoots.from(file("linux/src"))
        }

        configureEach {
            suppress.set(false)
            displayName.set(name)
            documentedVisibilities.set([VisibilityModifier.Public] as Set)
            reportUndocumented.set(false)
            skipEmptyPackages.set(true)
            skipDeprecated.set(false)
            suppressGeneratedFiles.set(true)
            jdkVersion.set(8)
            languageVersion.set("1.7")
            apiVersion.set("1.7")
            sourceRoots.from(file("src"))
            classpath.from(file("libs/dependency.jar"))
            samples.from("samples/Basic.kt", "samples/Advanced.kt")

            sourceLink {
                localDirectory.set(file("src/main/kotlin"))
                remoteUrl.set(new URI("https://example.com/src"))
                remoteLineSuffix.set("#L")
            }

            externalDocumentationLinks {
                url.set(new URI("https://example.com/docs/"))
                packageListUrl.set(new File("/path/to/package-list").toURI().toURL())
            }

            perPackageOption {
                matchingRegex.set(".*api.*")
                suppress.set(false)
                skipDeprecated.set(false)
                reportUndocumented.set(false)
                documentedVisibilities.set([
                        VisibilityModifier.Public,
                        VisibilityModifier.Private,
                        VisibilityModifier.Protected,
                        VisibilityModifier.Internal,
                        VisibilityModifier.Package
                ] as Set)
            }
        }
    }
}

빌더

특수 클래스 및 인터페이스

속성

Kotlin 및 Spring Boot로 웹 앱 만들기

Kotlin/JS

WebAssembly (Wasm)

메모리 관리자

인지 복잡성 최소화

Dokka

Dokka 실행

출력 형식

Java에서 Kotlin으로 마이그레이션 가이드

Swift/Objective-C 상호 운용

C 상호 운용

Kotlin Notebook 시작하기

데이터 소스 작업

데이터 시각화

컬렉션

검색

연산 및 연산자

Kotlin 2.2.x

Kotlin 2.1.x

Kotlin 2.0.x

Kotlin 1.9.x

Kotlin 1.8.x

Kotlin 1.7.x

Kotlin 1.6.x

Kotlin 1.5.x

Kotlin 1.4.x

Kotlin 1.3.x

Dokka Gradle 설정 옵션

일반 설정 (General configuration)

소스 세트 설정 (Source set configuration)

소스 링크 설정 (Source link configuration)

패키지 옵션 (Package options)

외부 문서 링크 설정 (External documentation links configuration)

전체 설정 (Complete configuration)

Dokka 실행

출력 형식

검색

연산 및 연산자

Dokka Gradle 설정 옵션 ​

일반 설정 (General configuration) ​

소스 세트 설정 (Source set configuration) ​

소스 링크 설정 (Source link configuration) ​

패키지 옵션 (Package options) ​

외부 문서 링크 설정 (External documentation links configuration) ​

전체 설정 (Complete configuration) ​

Dokka Gradle 설정 옵션

일반 설정 (General configuration)

소스 세트 설정 (Source set configuration)

소스 링크 설정 (Source link configuration)

패키지 옵션 (Package options)

외부 문서 링크 설정 (External documentation links configuration)

전체 설정 (Complete configuration)