ExternalDocumentationLinkBuilder

class ExternalDocumentationLinkBuilder

Configuration block that allows creating links leading to externally hosted documentation of your dependencies.

For instance, if you are using types from kotlinx.serialization, by default they will be unclickable in your documentation, as if unresolved. However, since API reference for kotlinx.serialization is also built by Dokka and is published on kotlinlang.org, you can configure external documentation links for it, allowing Dokka to generate documentation links for used types, making them clickable and appear resolved.

Example:

<externalDocumentationLinks>
<link>
<url>https://kotlinlang.org/api/latest/jvm/stdlib/</url>
<packageListUrl>file:/${project.basedir}/stdlib.package.list</packageListUrl>
</link>
</externalDocumentationLinks>

Constructors

Link copied to clipboard
fun ExternalDocumentationLinkBuilder()

Functions

Link copied to clipboard
fun build(): ExternalDocumentationLinkImpl

Properties

Link copied to clipboard
@Parameter(name = "packageListUrl", required = true)
var packageListUrl: URL? = null

Specifies the exact location of a package-list instead of relying on Dokka automatically resolving it. Can also be a locally cached file to avoid network calls.

Link copied to clipboard
@Parameter(name = "url", required = true)
var url: URL? = null

Root URL of documentation to link with. Must contain a trailing slash.