Dokkatoo Gradle Plugin/dev.adamko.dokkatoo.dokka.parameters/DokkaExternalDocumentationLinkSpec/url

url

fun url(value: String)(source)
fun url(value: Provider<String>)(source)

Set the value of url.

Parameters

value

will be converted to a URI

@get:Input
abstract val url: Property<URI>(source)

Root URL of documentation to link with.

Dokka will do its best to automatically find package-list for the given URL, and link declarations together.

It automatic resolution fails or if you want to use locally cached files instead, consider providing packageListUrl.

Example:

java.net.URI("https://kotlinlang.org/api/kotlinx.serialization/")
Content copied to clipboard