Dokka -跳过为默认的android包生成javadoc

Question

我试图使用Dokka插件为android应用程序生成Javadoc。我把插件添加到我的gradle中：

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

然后，我按照项目说明进行了基本配置：

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

我使用basic 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版本中，以下提交似乎解决了"抑制dokka-android中的android.R和其他生成的物质的输出“问题，但显然在使用所需信息创建suppresedFiles映射之后，它并没有真正用于筛选sourceSets。

UPDATE：使用修复程序的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.