HardCopyWorld.com

Dokka – Android package 및 API 문서 생성

by ·

Android project 의 package 및 API 문서는 아래 방법으로 생성해서 확인할 수 있습니다.

Project level – Gradle 설정

buildscript {
    ext {
        gradle_ver = '4.1.0'
        dokka_ver = "0.9.18"

...

dependencies {
    // To prevent below error, set gradle version as 3.3.2 and kotlin as 1.3.0
    // Android dependency 'androidx.core:core' has different version for the compile...
    classpath 'com.android.tools.build:gradle:4.1.1'
    classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_ver"
    classpath "org.jetbrains.dokka:dokka-android-gradle-plugin:$dokka_ver"
...

App level – Gradle 설정

apply plugin: 'org.jetbrains.dokka-android'

dokka {
    moduleName = 'your_module_name'
    outputFormat = 'javadoc'
    outputDirectory = "$projectDir/docs"
    sourceDirs = files('src/main/java')
    skipEmptyPackages = true
    linkMapping {
        dir = "src/main/java"
        url = "http://your_domain"
        suffix = "#L"
    }
}

위 dokka 설정에서 moduleName, outputDirectory 를 확인합니다.

Doc 생성 방법

Terminal 에서 아래 커맨드 실행 (Windows)

  • gradlew dokka

터미널 메시지 확인 후 완료되면 output directory 에서 생성 결과 확인하면 됩니다.

참고


You may also like...