Android用にdokkaをセットアップする

2021/01/25
dokka
Android

ドキュメント生成ツールdokkaをAndroid用にセットアップする手順です。

環境

  • Android Gradle Plugin 4.1.1
  • Gradle 6.5
  • dokka 1.4.20

手順

トップレベルのbuild.gradleにdokkaのclasspathを指定します。

buildscript {
    ext.kotlin_version = "1.3.72"
    ext.dokka_version = "1.4.20"
    repositories {
        google()
        jcenter()
    }
    dependencies {
        classpath "com.android.tools.build:gradle:4.1.1"
        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
        classpath "org.jetbrains.dokka:dokka-gradle-plugin:$dokka_version"
    }
}

allprojects {
    repositories {
        google()
        jcenter()
    }
}

task clean(type: Delete) {
    delete rootProject.buildDir
}

モジュールレベルのbuild.gradleでコマンドの生成と設定を記述します。

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

android {
  //  ...
}

dokkaGfm.configure{
    outputDirectory.set(new File("${projectDir}/dokka"))
    moduleName.set("HogeModule")
    dokkaSourceSets{
        named("main"){
            supress.set(true)
            noJdkLink.set(false)
            noAndroidSdkLink.set(false)
            //  ...
        }
    }
}

gradleタスクが生成されるので、実行するとドキュメントが生成されます

# Windows
> gradlew.bat dokkaGfm

# Others
> ./gradlew dokkaGfm

参考

Gradle - Dokka

© 2019-2021 hassakulab.com, built with Gatsby