android studio kotlin インターフェイス ドキュメントのエクスポート

以前は java を使用してインターフェイス ドキュメントを記述し、記述後は付属の関数を直接使用してインターフェイス ドキュメントを直接エクスポートしました。

これでインターフェースドキュメントをそのまま出力先にエクスポートすることができますが、kotlinでインターフェースを定義する場合、直接使うとエラーになるので、

別の方法を採用します。

公式推奨の dokka プラグインを使用する

使い方
まず、アクセス依存関係をアプリgradleに統合

buildscript {
  ...
    dependencies {
       ...
        classpath("org.jetbrains.dokka:dokka-gradle-plugin:1.7.20")
    }
}

plugins {
   ...
    id("org.jetbrains.dokka") version "1.7.20"
}

...

dependencies {
   ...
    dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.7.20")
}
// 配置导出信息
tasks.dokkaJavadoc.configure {
    // 导出的文档目录路径
    outputDirectory.set(new File(rootDir, "doc"))
//    dokkaSourceSets {
//        named("main") {
//            noAndroidSdkLink.set(true)
//            noStdlibLink.set(true)
//            noJdkLink.set(true)
//        }
//        configureEach {
//            // 包的定义
//            includes.from("packages.md")
//        }
//    }
}

という簡単な設定をして、右側のgradleのdcumentationの下にあるタスクdokkaJavaDocを直接クリックすると、プロジェクトのローカルルートディレクトリにインターフェースドキュメントが生成されるので、その中のindex.htmlを開いて見るインターフェイス

ドキュメント