Dokka-跳過為默認android包生成javadoc

Question

我正在嘗試使用Dokka插件為Android Kotlin應用程序生成Javadoc。 我將插件添加到了gradle中：

classpath "org.jetbrains.dokka:dokka-gradle-plugin:0.9.15"

然后，按照項目說明進行了基本配置：

dokka {
    outputFormat = 'javadoc'
    outputDirectory = "$rootDir/docs"
    skipEmptyPackages = true
    noStdlibLink = true
}

我使用基本的gradle命令生成文檔：

[user@linux AppDir]$ bash gradlew dokka

輸出很好，但是它包含來自Android或我添加到項目中的插件的多個目錄，例如：

android.R
android.support
com.google
com.crashlytics
.
.
.
etc.

如何跳過這些軟件包？ 有什么方法只能為我的/ app / scr / java文件夾和我創建的文件生成擴展塢嗎？ 任何幫助表示贊賞。

Answer 1

Dokka 0.9.16版將包含一個錯誤修正，用於從文檔中刪除生成的文件 。

在0.9.15版中，以下提交似乎解決了“ 抑制android.R和dokka-android中其他生成的東西的輸出 ”的問題，但是顯然在創建帶有所需信息的suppresedFiles映射之后，它並沒有真正用於過濾sourceSets 。

---

更新 ： Dokka 0.9.16已隨修復程序一起發布，並進行了其他改進。

＃224從文檔中過濾掉Android生成的類

Answer 2

這是Dokka 0.9.16的工作示例：

task dokka(overwrite: true, type: org.jetbrains.dokka.gradle.DokkaAndroidTask) {
    outputFormat = 'javadoc'
    outputDirectory = "$buildDir/docs"

    // Do not create index pages for empty packages
    skipEmptyPackages = true

    //Do not output deprecated members. Applies globally, can be overridden by packageOptions
    skipDeprecated = false

    //No default documentation link to kotlin-stdlib
    noStdlibLink = false
}

如果使用Android，則類型很重要： org.jetbrains.dokka.gradle.DokkaAndroidTask

不是DokkaTask而是DokkaAndroidTask 。