Dokka v2 - External Documentaiton Links

dokka-links.md

Dokka v2 - External Documentation Links

A collection of properly configured external documentation links to use in Dokka v2

How to use

Register the necessary documentation link source in dokka source sets:

dokka {
    dokkaSourceSets.configureEach {
        externalDocumentationLinks {
            // 1. Search for the necessary library
            // 2. Pase the found snippet here
        }
    }
}

Example with kotlinx.coroutines:

dokka {
    dokkaSourceSets.configureEach {
        externalDocumentationLinks {
            register("kotlinx.coroutines") {
                url("https://kotlinlang.org/api/kotlinx.coroutines/")
            }
        }
    }
}

Links

register("kotlinx.coroutines") {
    url("https://kotlinlang.org/api/kotlinx.coroutines/")
}

register("kotlinx.serialization") {
    url("https://kotlinlang.org/api/kotlinx.serialization/")
}

register("kotlinx-io") {
    url("https://kotlinlang.org/api/kotlinx-io/")
}

register("kotlinx-datetime") {
    url("https://kotlinlang.org/api/kotlinx-datetime/")
    // See: https://github.com/Kotlin/kotlinx-datetime/issues/268
    packageListUrl("https://kotlinlang.org/api/kotlinx-datetime/kotlinx-datetime/package-list")
}

register("ktor") {
    url("https://api.ktor.io/")
}

register("kotlin-wrappers") {
    url("https://jetbrains.github.io/kotlin-wrappers/")
}

Tip

Feel free to share your snippets in comments