Dokka-跳过为默认的android包生成javadoc [英] Dokka - skip generating javadoc for default android packages

问题描述

我正在尝试使用Dokka插件为Android Kotlin应用程序生成Javadoc.我将插件添加到了gradle中:

I am trying to use Dokka plugin to generate Javadoc for android Kotlin application. I added the plugin to my gradle:

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

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

Then I made a basic configuration following project instructions:

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

我使用基本的gradle命令生成文档:

I generate documentation using basic gradle command:

[user@linux AppDir]$ bash gradlew dokka

输出很好，但是它包含来自android或我添加到项目中的插件的多个目录，例如:

Output is fine, but it includes multiple directories from android or plugins I have added to my project, for example:

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

如何跳过这些软件包?有什么方法可以只为我的/app/scr/java文件夹和我创建的文件生成扩展坞吗?感谢您的帮助.

How do I skip these packages? Is there any way to generate dock only for my /app/scr/java folder, and files I created? Any help is appreciated.

推荐答案

Dokka版本0.9.16将包含

Dokka version 0.9.16 will include a bugfix to remove generated files from documentation.

在0.9.15版本中，以下提交似乎解决了"抑制android的输出. R和其他在dokka-android 中生成的东西"，但是显然在使用所需信息创建suppresedFiles映射之后，并没有真正使用它来过滤sourceSets.

In version 0.9.15, the following commit seemed to address that "Suppress output of android.R and other generated stuff in dokka-android", but apparently after creating the suppresedFiles map with the needed information, it was not really used to filter sourceSets.

更新: Dokka 0.9.16已经发布并附带修复程序.

#224 从文档中过滤掉Android生成的类

#224 Filtered out Android generated classes from docs

这篇关于Dokka-跳过为默认的android包生成javadoc的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！