KotlinのAndroidアプリのAPIドキュメントを自動生成する

KotlinでAndroidアプリを作っていてAPIドキュメントをJavadocのように生成したかったのですが、KotlinだとJavadocは使えませんでした。
調べてみたらKotlinではDokkaというのを使うらしいです。
導入方法は公式のREADMEにも書いてあるんですけど、個人的メモ用として記事にしました。

まずプロジェクトのルートのbuild.gradleに、以下のclasspath指定を追加します。

%ROOT%/build.gradle

// Top-level build file where you can add configuration options common to all sub-projects/modules.

buildscript {
    repositories {
        jcenter()
    }
    dependencies {
        classpath 'org.jetbrains.dokka:dokka-android-gradle-plugin:0.9.17' // これを追加
    }
}

次に、アプリケーションのbuild.gradleにapply pluginの記述を追加し、出力設定を行うためのdokkaブロックを定義します。

app/build.gradle

apply plugin: 'com.android.application'
apply plugin: 'kotlin-android'
apply plugin: 'org.jetbrains.dokka-android' // これを追加(kotlin-android よりも下に追加すること)

// このブロックを android ブロックの下あたりに追加
dokka {
    outputFormat = 'html'
    outputDirectory = "$rootDir/javadoc" // 出力先。好きな場所を指定。
}

あとは、プロジェクトのルートでgradlew dokkaを実行するだけです。

もしくは、Android Studioの右の方にあるGradleタブから dokka というタスクを探してダブルクリックしても良いです。

簡単な設定だけで本格的なAPIドキュメントが生成できますし、これを読むと「あ、このクラスのコメントもう少し詳しく書いたほうが良さそうだな」とかいうことに気付けてとても良いと思うので、ぜひ利用してみてください。

ちなみに、この方法でドキュメントを生成するためにはKDocという形式でソースコード中にコメントを入れておく必要があります。Javadocと似てますが、Javadocよりもう少し簡素な書き方ができます。
日頃からKDocのコメントをたくさんつけるように習慣づけておきましょう。