Kotlin版Javadoc(Kdoc)を生成できる「dokka」の導入手順

3439 ワード
Kdoc AndroidStudio dokka Kotlin Kotlin テキストリンク

Kotlin版Javadoc（Kdoc）のドキュメントを作れるdokkaというライブラリがあります。
その導入手順を紹介します。

環境

  • Mac OSX 10.13.4
  • Android Studio 3.1
  • dokka 0.9.17

dokkaの導入手順

今回はAndroid Studioを使った導入手順なので、gradleを使用します。
app/build.gradleに以下を追加します。

app/build.gradle
apply plugin: 'kotlin-android'
apply plugin: 'org.jetbrains.dokka-android'

dokka {
   outputFormat = 'javadoc'
   sourceDirs = files('src/main')
   outputDirectory = "$buildDir/javadoc"
}

'org.jetbrains.dokka-android'は'kotlin-android'より後に入れます。
outputFormatにはjavadocのほかhtmlやmarkdownなども選択できます。
また、sourceDirsにはソースコードのあるディレクトリの場所を指定します。これは適宜変えてください。

続いて、ルート直下のbuild.gradleに以下を追加します。

build.gradle
buildscript {
    ext.dokka_version = '0.9.17'

    repositories {
        jcenter()
    }

    dependencies {
        classpath "org.jetbrains.dokka:dokka-android-gradle-plugin:${dokka_version}"
    }
}

ここまでできたら、Android Studioのターミナルから

./gradlew dokka

を実行するとjavadocが生成できますが・・・

プロジェクトで使用している外部ライブラリによっては失敗することがあります。

失敗した場合

ターミナルでjava -versionを実行してjavaのバージョンをチェックし、JDK9以上を使用している場合はJDK8を使うように変更します。これで成功するはずです。

kdoc-generator

kdoc-generatorはAndroidStudioで使用できる、Kdocを自動で生成してくれるプラグインです。

(https://plugins.jetbrains.com/plugin/10389-kdoc-generator より引用)

おわりに

https://github.com/Kotlin/dokka
dokkaについてさらに詳しく知りたい人はここを参照しましょう。