Include Kotlin/Native KDocs documentation in built .frameworks for iOS/XCode

Question

I'm developing a Kotlin/Native library for both iOS and Android.

When running ./gradlew assemble I get the release/debug .frameworks with Obj-C Headers.

I can use these .frameworks fine. But I would also like to carry on with documentation of classes and functions when using the code on XCode.

If I use KDoc and document my code:

/**
 * 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)
    }

}

All of this is lost when bringing it to my iOS project. Because the .frameworks don't carry the KDocs with it.

Is there any way to carry the documentation over to the Obj-C Headers or other auxiliary files when assembling the .framework files? Maybe some Gradle configuration I am missing?

Yeah that would be helpful indeed – Matheus Valin Apr 07 '20 at 15:56 — Matheus Valin, Apr 07 '20 at 15:56

score 1 · Accepted Answer · answered Apr 07 '20 at 16:49

1

There is no pre-made option for this, you can upvote an issue here.

answered Apr 07 '20 at 16:49

Artyom Degtyarev

2,704
8
23

score 1 · Answer 2 · edited Aug 31 '23 at 12:34

1

You can configure your module's build.gradle.kts as described here:

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

This enables the ability to export KDoc comments to generated Objective-C headers.

edited Aug 31 '23 at 12:34

Adrian Mole

49,934
160
51
83

answered Aug 29 '23 at 07:49

Eugene Shilov

11
3

Include Kotlin/Native KDocs documentation in built .frameworks for iOS/XCode

2 Answers2