[Android] Dokka를 활용하여 프로젝트 문서화하기

Kotlin 코드를 Dokka로 문서화하기

Dokka를 활용하면 HTML, Markdown 등의 형태로 kolin 코드를 문서화할 수 있다.

1. Build gradle에 Dokka plugin 추가

Kotlin DSL, Multi-Module을 사용한 안드로이드 프로젝트를 기준으로 그 방법을 작성하였다.

 

build.gradle.kts(project)

plugins {
    id("org.jetbrains.dokka") version "1.9.10" apply false
}

tasks.dokkaHtmlMultiModule {
    moduleName.set("WHOLE PROJECT NAME USED IN THE HEADER")
}

 

build.gradle.kts(app)

plugins {
    id 'com.android.application'
    id 'org.jetbrains.kotlin.android'
    id 'org.jetbrains.dokka'
}

dependencies {
    ...

    implementation 'org.jetbrains.dokka:dokka-gradle-plugin:1.9.10'
    dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.9.10")
}

 

다른 모듈들에 대해서도 똑같이 작성해주면 된다.

 

2. Dokka task를 실행하여 문서화

./gradlew dokkaHtmlMultiModule

 

 

만약 아래와 같이 configuration 관련 이슈가 발생한다면 --no-configuration-cache 옵션을 추가해준다.

FAILURE: Build failed with an exception.

* What went wrong:
Configuration cache problems found in this build.

 

./gradlew dokkaHtmlMultiModule --no-configuration-cache

 

dokkaHtmlMultiModule task를 수행하면 기본 outputDirectory인 build/dokka/HtmlMultiModule 아래에 index.html를 포함한 문서가 생성된다.

 

참고

https://kotlinlang.org/docs/dokka-gradle.html#multi-project-configuration

Gradle | Kotlin

https://kotlinlang.org/docs/kotlin-doc.html

Document Kotlin code: KDoc | Kotlin