在适用于 iOS/XCode 的内置 .frameworks 中包含 Kotlin/Native KDocs 文档

Question

我正在为 iOS 和 Android 开发一个 Kotlin/Native 库。

运行时

./gradlew assemble

我得到带有 Obj-C 标头的发布/调试

.framework

。

我可以使用这些

.framework

很好。但我还想在 XCode 上使用代码时继续提供类和函数的文档。

如果我使用 KDoc 并记录我的代码：

/**
 * This is a comment about the class I developed.
 * [BaseService] is a class.
 */
class BaseService {

    /**
     * Comments about this val
     */
    val greeting = "Hello"

    /**
     * This function greets the user
     */
    fun greetUser(){
        println(greeting)
    }

}

将其引入我的 iOS 项目时，所有这些都丢失了。因为

.framework

不带有 KDocs。

在组装

.framework

文件时，有什么方法可以将文档转移到 Obj-C 头文件或其他辅助文件中吗？也许我缺少一些 Gradle 配置？

Answer 1

没有预先设置的选项，您可以在此处对问题进行投票。

Answer 2

您可以按照此处所述配置模块的build.gradle.kts：

kotlin {
    targets.withType<org.jetbrains.kotlin.gradle.plugin.mpp.KotlinNativeTarget> {
        compilations.get("main").compilerOptions.options.freeCompilerArgs.add("-Xexport-kdoc")
    }
}

这使得能够将 KDoc 注释导出到生成的 Objective-C 标头。