Dokka Documentation Extension

Provides extension for Kotlin Dokka to link with documentations hosted in javadoc.io and jitpack.io.

Usage

First, you need to apply dokka plugin, as explained in Dokka Guide, after than, you need to apply this plugin:

plugins {
  id "io.github.jonathanxd.dokka-doc-io" version "1.2.2-jdk15"
}

For Kotlin DSL

plugins {
    id("io.github.jonathanxd.dokka-doc-io") version "1.2.2-jdk15"
}

Standard plugin versions (such as 1.2.2 are built using Java 17).

Defining documentations

The documentation link definition looks like the dependency declaration notation:

tasks.dokkaHtml.configure {
    dokkaSourceSets {
        configureEach {
            docs {
                link {
                    javadocIo("com.github.jonathanxd:textlexer:1.7")
                    jitpackIo("com.github.koresframework:KoresProxy:2.6.1")
                }
            }
        }
    }
}

For documentations that uses element-list instead of package-list, use the following syntax:

tasks.dokkaHtml.configure {
    dokkaSourceSets {
        configureEach {
            docs {
                link {
                    javadocIo("com.github.jonathanxd:textlexer:1.7", ELEMENT_LIST)
                    jitpackIo("com.github.koresframework:KoresProxy:2.6.1", ELEMENT_LIST)
                }
            }
        }
    }
}

You could also specify your own package-list file:

tasks.dokkaHtml.configure {
    dokkaSourceSets {
        configureEach {
            docs {
                link {
                    javadocIo("com.github.jonathanxd:textlexer:1.7", "my-package-list")
                    jitpackIo("com.github.koresframework:KoresProxy:2.6.1", "my-package-list")
                }
            }
        }
    }
}

Experimental versions

To use experimental versions, you need to declare the plugin in the buildscript using jitpack.io as a maven repository, for example:

buildscript {
    repositories {
        maven(url = "https://jitpack.io")
    }
    dependencies {
        classpath("com.github.JonathanxD.dokka-doc-io:dokka-doc-io-gradle:-SNAPSHOT") {
            isChanging = true
        }
    }
}

plugins {
    kotlin("jvm") version "1.5.0"
    id("org.jetbrains.dokka") version "1.4.32"
}

apply(plugin = "io.github.jonathanxd.dokka-doc-io")

Maven Repository

You could also use Maven Repository as the central for plugins, there are two ways to do that, the first one is to configure as a buildscript in your build.gradle.kts:

buildscript {
    repositories {
        mavenCentral()
    }
    dependencies {
        classpath("io.github.jonathanxd:dokka-doc-io:1.2.2-jdk15")
    }
}

apply(plugin = "io.github.jonathanxd.dokka-doc-io")

And the second one is to configure a custom resolution for the plugin in the settings.gradle.kts:

pluginManagement {
    resolutionStrategy {
        eachPlugin {
            if (requested.id.namespace == "io.github.jonathanxd") {
                useModule("io.github.jonathanxd:dokka-doc-io:1.2.2-jdk15")
            }
        }
    }
    repositories {
        mavenCentral()
        gradlePluginPortal()
    }
}

And in your build.gradle.kts:

plugins {
    id("io.github.jonathanxd.dokka-doc-io") version "1.2.2-jdk15"
}