gradle-plugin/org.jetbrains.dokka.gradle/GradleSourceLinkBuilder

GradleSourceLinkBuilder

class GradleSourceLinkBuilder(project: Project) : DokkaConfigurationBuilder<SourceLinkDefinitionImpl>

Configuration builder that allows adding a source link to each signature which leads to remoteUrl with a specific line number (configurable by setting remoteLineSuffix), letting documentation readers find source code for each declaration.

Example in Gradle Kotlin DSL:

sourceLink {
    localDirectory.set(projectDir.resolve("src"))
    remoteUrl.set(URL("https://github.com/kotlin/dokka/tree/master/src"))
    remoteLineSuffix.set("#L")
}

Constructors

GradleSourceLinkBuilder

fun GradleSourceLinkBuilder(project: Project)

Functions

build

open override fun build(): SourceLinkDefinitionImpl

Properties

localDirectory

@Internal

val localDirectory: Property<File?>

Path to the local source directory. The path must be relative to the root of current project.

remoteLineSuffix

@Optional

@Input

val remoteLineSuffix: Property<String>

Suffix used to append source code line number to the URL. This will help readers navigate not only to the file, but to the specific line number of the declaration.

remoteUrl

@Input

val remoteUrl: Property<URL?>

URL of source code hosting service that can be accessed by documentation readers, like GitHub, GitLab, Bitbucket, etc. This URL will be used to generate source code links of declarations.