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

Posted 2023-04-15

【中文标题】在 iOS/XCode 的内置 .frameworks 中包含 Kotlin/Native KDocs 文档

【英文标题】：Include Kotlin/Native KDocs documentation in built .frameworks for iOS/XCode

【发布时间】：2020-07-19 19:23:26

【问题描述】：

我正在为 ios 和 android 开发一个 Kotlin/Native 库。

当运行 ./gradlew assemble 时，我得到了带有 Obj-C 标头的发布/调试 .frameworks。

我可以很好地使用这些.frameworks。但在 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 项目时，所有这些都丢失了。因为.frameworks 不携带KDocs。

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

【问题讨论】：

是的，这确实很有帮助

【参考方案1】：

没有预先设置的选项，您可以在here 上投票。