Dokka 시작하기

Dokka 시작하기 (Get started with Dokka)

아래에는 Dokka를 시작하는 데 도움이 되는 간단한 안내가 있어요.

출처: Get started with Dokka

본문

NOTE: 이 가이드는 Dokka Gradle 플러그인(DGP) v2 모드에 적용돼요. DGP v1 모드는 더 이상 지원되지 않아요. v1에서 v2 모드로 업그레이드하려면 Migration 가이드를 따르세요.

Gradle Dokka 플러그인 적용하기 (Apply the Gradle Dokka plugin)

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

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

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

멀티 프로젝트 빌드 문서화하기 (Document multi-project builds)

멀티 프로젝트 빌드를 문서화할 때는, 문서화하려는 모든 하위 프로젝트에 플러그인을 적용해야 해요. 하위 프로젝트 전체에서 Dokka 구성을 공유하려면 다음 방법 중 하나를 사용해요.

  • 컨벤션 플러그인

  • 컨벤션 플러그인을 쓰지 않는다면 각 하위 프로젝트에서 직접 구성

멀티 프로젝트 빌드에서 Dokka 구성을 공유하는 방법에 대한 자세한 내용은 Multi-project 구성을 참고하세요.

문서 생성하기 (Generate documentation)

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

./gradlew :dokkaGenerate

이 태스크는 단일 프로젝트 빌드와 멀티 프로젝트 빌드 모두에서 동작해요.

태스크 앞에 프로젝트 경로(:)를 붙여서 집계(aggregating) 프로젝트에서 dokkaGenerate 태스크를 실행해요. 예를 들어:

./gradlew :dokkaGenerate

// OR

./gradlew :aggregatingProject:dokkaGenerate

./gradlew :dokkaGenerate나 ./gradlew :aggregatingProject:dokkaGenerate 대신 ./gradlew dokkaGenerate를 실행하는 것은 피하세요. 태스크 앞에 프로젝트 경로(:)를 붙이지 않으면 Gradle이 전체 빌드에 걸쳐 모든 dokkaGenerate 태스크를 실행하려고 시도해서, 불필요한 작업이 발생할 수 있어요.

출력을 HTML, Javadoc 또는 HTML과 Javadoc 둘 다로 생성하는 데 서로 다른 태스크를 사용할 수 있어요.

TIP: Gradle에서 Dokka를 사용하는 방법을 더 자세히 알고 싶다면 Gradle을 참고하세요.

Maven 플러그인 적용하기

POM 파일의 plugins 섹션에 Dokka용 Maven 플러그인을 추가해요.

<build>
    <plugins>
        <plugin>
            <groupId>org.jetbrains.dokka</groupId>
            <artifactId>dokka-maven-plugin</artifactId>
            <version>2.2.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을 참고하세요.