kotlin Dokka未生成测试包的文档

fgw7neuy  于 2023-06-06  发布在  Kotlin
关注(0)|答案(1)|浏览(172)

我的测试代码中有KDoc样式的注解,我想使用KotlinDSL Gradle dokkaHtml任务生成文档。但在成功执行任务后,它会显示**“正在退出生成:没有什么可记录的。
我试过设置来源,但什么都没有改变。我想获取测试包中代码的html文档。

pjngdqdw

pjngdqdw1#

Dokka旨在用于记录库的源代码,提供有关API如何工作的文档。test源代码集应该包含用于测试库代码的单元测试,并且不一定还要记录库;这是库本身的工作,main源集。示例函数(https://kotlinlang.org/docs/kotlin-doc.html#sample-identifier)将生成文档。或者,您可以配置dokka将test源代码集视为源代码,而不是测试代码:

tasks.withType<DokkaTask>().configureEach {
    dokkaSourceSets {
        named("test") {
            sourceRoots.from(file("src/test/"))
        }
    }
}

另见:https://kotlinlang.org/docs/dokka-gradle.html#source-set-configuration

相关问题