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文件夹和我创建的文件生成dock？任何帮助表示赞赏。

Answer 1

Dokka 0.9.16版将包含bugfix to remove generated files from documentation。

在版本0.9.15中，以下提交似乎解决了＆＃34; Suppress output of android.R and other generated stuff in dokka-android＆＃34;，但显然在创建了包含所需信息的suppresedFiles地图之后，它实际上并不是真的用于过滤sourceSets。

更新：Dokka 0.9.16 has been released以及其他改进措施。

#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 。

干杯，保罗

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

2 个答案: