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

标签 android gradle kotlin javadoc kotlin-dokka

我正在尝试使用 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 文件夹和我创建的文件生成扩展坞?任何帮助表示赞赏。

最佳答案

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

在 0.9.15 版中,以下提交似乎解决了“Suppress output of android.R and other generated stuff in dokka-android”,但显然在使用所需信息创建 suppredFiles 映射之后,它并没有真正用于过滤 sourceSets.


更新:Dokka 0.9.16 has been released修复,以及其他改进。

#224 Filtered out Android generated classes from docs

关于android - Dokka - 跳过为默认的 android 包生成 javadoc,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/46099054/

相关文章:

android - libgdx 中的 scene2D - 动画不工作

API 26 模拟器上的 Android WidgetPreview 错误

android - 没有这样的属性 : variantConfiguration for class:

android - 错误 :Execution failed for task ':app:prepareDebugAndroidTestDependencies' . > 依赖性错误。详情见控制台

android - 如果 null 其他不起作用

android - Sceneform透明 Material

android - 证书和 keystore

Android 上的 Java - 威胁?

android-studio - Android Studio中的构建配置错误

java - Dagger2 错误 : Kotlin: Unresolved reference: DaggerSOMETHINGComponent