Dokka 시작하기

Dokka를 시작하는 데 도움이 되는 간단한 지침을 아래에서 확인할 수 있습니다.

Gradle Kotlin DSLGradle Groovy DSLMaven

이 가이드는 Dokka Gradle 플러그인(DGP) v2 모드에 적용됩니다. DGP v1 모드는 더 이상 지원되지 않습니다. v1에서 v2 모드로 업그레이드하려면 마이그레이션 가이드를 따르세요.

Gradle Dokka 플러그인 적용하기

프로젝트의 루트 빌드 스크립트에 Dokka Gradle 플러그인(DGP)을 적용하세요:

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

멀티 프로젝트 빌드 문서화하기

멀티 프로젝트 빌드를 문서화할 때는 문서화하려는 모든 서브프로젝트에 플러그인을 적용해야 합니다. 다음 방법 중 하나를 사용하여 서브프로젝트 전체에 Dokka 설정을 공유하세요:

• 컨벤션 플러그인(Convention plugin)
• 컨벤션 플러그인을 사용하지 않는 경우 각 서브프로젝트에서 직접 설정

멀티 프로젝트 빌드에서의 Dokka 설정 공유에 대한 자세한 내용은 멀티 프로젝트 설정을 참조하세요.

문서 생성하기

문서를 생성하려면 다음 Gradle 태스크를 실행하세요:

./gradlew :dokkaGenerate

이 태스크는 단일 및 멀티 프로젝트 빌드 모두에서 작동합니다.

집계(aggregating) 프로젝트에서 dokkaGenerate 태스크를 실행할 때, 태스크 앞에 프로젝트 경로(:)를 접두사로 붙여서 실행하세요. 예:

./gradlew :dokkaGenerate

// 또는

./gradlew :aggregatingProject:dokkaGenerate

./gradlew :dokkaGenerate 또는 ./gradlew :aggregatingProject:dokkaGenerate 대신 ./gradlew dokkaGenerate를 실행하는 것은 피하세요. 태스크 앞에 프로젝트 경로(:) 접두사가 없으면 Gradle은 전체 빌드에서 모든 dokkaGenerate 태스크를 실행하려고 시도하며, 이로 인해 불필요한 작업이 발생할 수 있습니다.

HTML, Javadoc 또는 HTML과 Javadoc 모두로 출력물을 생성하기 위해 서로 다른 태스크를 사용할 수 있습니다.

Gradle에서 Dokka를 사용하는 방법에 대해 더 자세히 알아보려면 Gradle을 참조하세요.

이 가이드는 Dokka Gradle 플러그인(DGP) v2 모드에 적용됩니다. DGP v1 모드는 더 이상 지원되지 않습니다. v1에서 v2 모드로 업그레이드하려면 마이그레이션 가이드를 따르세요.

Gradle Dokka 플러그인 적용하기

프로젝트의 루트 빌드 스크립트에 Dokka Gradle 플러그인을 적용하세요:

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

멀티 프로젝트 빌드 문서화하기

멀티 프로젝트 빌드를 문서화할 때는 문서화하려는 모든 서브프로젝트에 플러그인을 적용해야 합니다. 다음 방법 중 하나를 사용하여 서브프로젝트 전체에 Dokka 설정을 공유하세요:

• 컨벤션 플러그인(Convention plugin)
• 컨벤션 플러그인을 사용하지 않는 경우 각 서브프로젝트에서 직접 설정

멀티 프로젝트 빌드에서의 Dokka 설정 공유에 대한 자세한 내용은 멀티 프로젝트 설정을 참조하세요.

문서 생성하기

문서를 생성하려면 다음 Gradle 태스크를 실행하세요:

./gradlew :dokkaGenerate

이 태스크는 단일 및 멀티 프로젝트 빌드 모두에서 작동합니다.

집계(aggregating) 프로젝트에서 dokkaGenerate 태스크를 실행할 때, 태스크 앞에 프로젝트 경로를 접두사로 붙여서 실행하세요. 예:

./gradlew :dokkaGenerate

// 또는

./gradlew :aggregatingProject:dokkaGenerate

./gradlew :dokkaGenerate 또는 ./gradlew :aggregatingProject:dokkaGenerate 대신 ./gradlew dokkaGenerate를 실행하는 것은 피하세요. 태스크 앞에 프로젝트 경로(:) 접두사가 없으면 Gradle은 전체 빌드에서 모든 dokkaGenerate 태스크를 실행하려고 시도하며, 이로 인해 불필요한 작업이 발생할 수 있습니다.

HTML, Javadoc 또는 HTML과 Javadoc 모두로 출력물을 생성하기 위해 서로 다른 태스크를 사용할 수 있습니다.

Gradle에서 Dokka를 사용하는 방법에 대해 더 자세히 알아보려면 Gradle을 참조하세요.

POM 파일의 plugins 섹션에 Maven용 Dokka 플러그인을 추가하세요:

<build>
    <plugins>
        <plugin>
            <groupId>org.jetbrains.dokka</groupId>
            <artifactId>dokka-maven-plugin</artifactId>
            <version>2.1.0</version>
            <executions>
                <execution>
                    <phase>pre-site</phase>
                    <goals>
                        <goal>dokka</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

문서를 생성하려면 dokka:dokka 골(goal)을 실행하세요.

기본적으로 출력 디렉터리는 target/dokka로 설정됩니다.

Maven에서 Dokka를 사용하는 방법에 대해 더 자세히 알아보려면 Maven을 참조하세요.