小编Har*_*rri的帖子

如何使用 Dokka 为主源集和 androidTest 源集生成 Android 库的 Javadoc?

我正在慢慢地将我的库项目从 Java 迁移到 Kotlin。我有一个要求,我还需要为 has 中的库和 Android 仪器测试提供 Javadoc。我无法再使用 Javadoc,因为它在看到 *.kt 文件时就会死掉。所以我转向多卡。

我的问题是我可以使用 Dokka 轻松生成 Javadoc,但仅限于主要源集。但我无法让它为我的仪器测试生成文档。

我在库构建 gradle 中有以下配置:

apply plugin: 'org.jetbrains.dokka'
...
dokkaJavadoc.configure {
    dokkaSourceSets {
        named("main") {
            // Main source set conf
            outputDirectory = file("dokkadoc/service-doc")
            includes.from(files("dokka_modules_test.md"))
            sourceRoots.from(file("src/main/java"))
        }
        named("androidTest") {
            // Test source set conf
            outputDirectory = file("dokkadoc/service-test-doc")
            includes.from(files("dokka_modules_test.md"))
            sourceRoots.from(file("src/androidTest/java"))
        }
        configureEach {
            // Shared conf for all source sets
            noAndroidSdkLink.set(false)
            includeNonPublic.set(false)
            skipEmptyPackages.set(true)
            reportUndocumented.set(true)
            skipDeprecated.set(false)
        }

    }
}
Run Code Online (Sandbox Code Playgroud)

在根 build.grade 中我导入:

buildscript {
    ..
    ext.dokka_version = '1.4.10.2'
    repositories …
Run Code Online (Sandbox Code Playgroud)

java android javadoc gradle dokka

8
推荐指数
0
解决办法
1662
查看次数

标签 统计

android ×1

dokka ×1

gradle ×1

java ×1

javadoc ×1