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 。