Dokka 시작하기

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

Gradle Kotlin DSLGradle Groovy DSLMaven

프로젝트의 루트 빌드 스크립트에 Dokka용 Gradle 플러그인을 적용합니다:

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

멀티 프로젝트 빌드를 문서화할 때, 서브프로젝트에도 Gradle 플러그인을 적용해야 합니다:

subprojects {
    apply(plugin = "org.jetbrains.dokka")
}

문서를 생성하려면 다음 Gradle 작업을 실행합니다:

• dokkaHtml (싱글 프로젝트 빌드용)
• dokkaHtmlMultiModule (멀티 프로젝트 빌드용)

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

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

프로젝트의 루트 빌드 스크립트에 Dokka용 Gradle 플러그인을 적용합니다:

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

멀티 프로젝트 빌드를 문서화할 때, 서브프로젝트에도 Gradle 플러그인을 적용해야 합니다:

subprojects {
    apply plugin: 'org.jetbrains.dokka'
}

문서를 생성하려면 다음 Gradle 작업을 실행합니다:

• dokkaHtml (싱글 프로젝트 빌드용)
• dokkaHtmlMultiModule (멀티 프로젝트 빌드용)

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

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

POM 파일의 plugins 섹션에 Dokka용 Maven 플러그인을 추가합니다:

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

문서를 생성하려면 dokka:dokka 목표를 실행합니다.

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

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

Dokka 2.0.0에서는 시작하기 위한 여러 단계와 작업이 업데이트되었습니다. 다음이 포함됩니다:

• 멀티 프로젝트 빌드 구성
• 업데이트된 작업으로 문서 생성
• 출력 디렉터리 지정

자세한 내용 및 전체 변경 목록은 마이그레이션 가이드를 참조하세요.