Kotlin / dokka

API documentation engine for Kotlin
https://kotl.in/dokka
Apache License 2.0
3.45k stars 411 forks source link

Linkify project sources, Android SDK classes and Kotlin documentation #1778

Open johnjohndoe opened 3 years ago

johnjohndoe commented 3 years ago

I am trying (for the first time) to use Dokka 1.4.20 to generate a JavaDoc artifact for my Kotlin based Android library.

apply plugin: "org.jetbrains.dokka"
// ...
task javadocJar(type: Jar, dependsOn: dokkaJavadoc) {
    group "publishing"
    description "Generates javadocJar based on Dokka"
    archiveClassifier.set("javadoc")
    from dokkaJavadoc.outputDirectory
}
dokkaJavadoc.configure {
    moduleName.set("Roadsigns")
    dokkaSourceSets {
        named("main") {
            sourceLink {
                localDirectory.set(file("roadsigns/src/main/kotlin"))
                remoteUrl.set(java.net.URL("https://github.com/Umweltzone/roadsigns/blob/master/roadsigns/src/main/kotlin"))
                remoteLineSuffix.set("#L")
            }
        }
    }
}

My understand is that noAndroidSdkLink is disabled by default - meaning: if I do not configure it then there should be links to Android docs.

Is your feature request related to a problem? Please describe

Describe the solution you'd like

Describe alternatives you've considered

Additional context image

MarcinAman commented 3 years ago

Hi, i might be mistaken but when i run original javadoc i also don't get the links in All implemented interfaces: image

The only thing that is a link there is inside a generic parameter of Comparable

johnjohndoe commented 3 years ago

Aehm, that might be correct. I was driven by my expectations. Feel free to split my feature request into parts.