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

GradleDokkaSourceSetBuilder

open class GradleDokkaSourceSetBuilder(val name: String, project: Project, sourceSetIdFactory: NamedDomainObjectFactory<DokkaSourceSetID>) : DokkaConfigurationBuilder<DokkaSourceSetImpl>

Source set level configuration.

Can be configured in the following way with Gradle Kotlin DSL:

import org.jetbrains.dokka.gradle.DokkaTask

tasks.dokkaHtml {
    dokkaSourceSets {
        // configure individual source set by name
        named("customSourceSet") {
            suppress.set(true)
        }

        // configure all source sets at once
        configureEach {
            reportUndocumented.set(true)
        }
    }
}

Constructors

GradleDokkaSourceSetBuilder

fun GradleDokkaSourceSetBuilder(name: String, project: Project, sourceSetIdFactory: NamedDomainObjectFactory<DokkaSourceSetID>)

Functions

build

open override fun build(): DokkaSourceSetImpl

dependsOn

fun dependsOn(sourceSetName: String)

fun dependsOn(sourceSet: SourceSet)

fun dependsOn(sourceSet: DokkaConfiguration.DokkaSourceSet)

fun dependsOn(sourceSetID: DokkaSourceSetID)

fun dependsOn(sourceSet: GradleDokkaSourceSetBuilder)

Convenient override to append source sets to dependentSourceSets

DokkaSourceSetID

fun DokkaSourceSetID(sourceSetName: String): DokkaSourceSetID

externalDocumentationLink

fun externalDocumentationLink(c: Closure<in GradleExternalDocumentationLinkBuilder>)

Closure for configuring external documentation links, appending to externalDocumentationLinks.

fun externalDocumentationLink(action: Action<in GradleExternalDocumentationLinkBuilder>)

Action for configuring external documentation links, appending to externalDocumentationLinks.

fun externalDocumentationLink(url: URL, packageListUrl: URL? = null)

fun externalDocumentationLink(url: String, packageListUrl: String? = null)

Convenient override to append external documentation links to externalDocumentationLinks.

perPackageOption

fun perPackageOption(c: Closure<in GradlePackageOptionsBuilder>)

Closure for configuring package options, appending to perPackageOptions.

fun perPackageOption(action: Action<in GradlePackageOptionsBuilder>)

Action for configuring package options, appending to perPackageOptions.

sourceLink

fun sourceLink(c: Closure<in GradleSourceLinkBuilder>)

Closure for configuring source links, appending to sourceLinks.

fun sourceLink(action: Action<in GradleSourceLinkBuilder>)

Action for configuring source links, appending to sourceLinks.

sourceRoot

fun sourceRoot(file: File)

fun sourceRoot(path: String)

Convenient override to append source roots to sourceRoots

Properties

apiVersion

@Input

@Optional

val apiVersion: Property<String?>

Kotlin API version used for setting up analysis and @sample environment.

classpath

@Classpath

@Optional

val classpath: ConfigurableFileCollection

Classpath for analysis and interactive samples.

dependentSourceSets

@Input

val dependentSourceSets: SetProperty<DokkaSourceSetID>

Specifies source sets that current source set depends on.

displayName

@Input

@Optional

val displayName: Property<String?>

Display name used to refer to the source set.

documentedVisibilities

@Input

val documentedVisibilities: SetProperty<DokkaConfiguration.Visibility>

Set of visibility modifiers that should be documented.

externalDocumentationLinks

val externalDocumentationLinks: SetProperty<GradleExternalDocumentationLinkBuilder>

Allows linking to Dokka/Javadoc documentation of the project's dependencies.

includeNonPublic

@Input

val includeNonPublic: Property<Boolean>

Deprecated. Use documentedVisibilities instead.

includes

@InputFiles

@Optional

@PathSensitive(value = PathSensitivity.RELATIVE)

val includes: ConfigurableFileCollection

List of Markdown files that contain module and package documentation.

jdkVersion

@Input

val jdkVersion: Property<Int>

JDK version to use when generating external documentation links for Java types.

languageVersion

@Input

@Optional

val languageVersion: Property<String?>

Kotlin language version used for setting up analysis and @sample environment.

name

@Transient

@get:Input

val name: String

noAndroidSdkLink

@Input

val noAndroidSdkLink: Property<Boolean>

Whether to generate external documentation links for Android SDK API reference when declarations from it are used.

noJdkLink

@Input

val noJdkLink: Property<Boolean>

Whether to generate external documentation links to JDK's Javadocs when declarations from it are used.

noStdlibLink

@Input

val noStdlibLink: Property<Boolean>

Whether to generate external documentation links that lead to API reference documentation for Kotlin's standard library when declarations from it are used.

perPackageOptions

val perPackageOptions: ListProperty<GradlePackageOptionsBuilder>

Allows to customize documentation generation options on a per-package basis.

platform

@Input

@Optional

val platform: Property<Platform>

Platform to be used for setting up code analysis and samples.

reportUndocumented

@Input

val reportUndocumented: Property<Boolean>

Whether to emit warnings about visible undocumented declarations, that is declarations without KDocs after they have been filtered by documentedVisibilities.

samples

@InputFiles

@Optional

@PathSensitive(value = PathSensitivity.RELATIVE)

val samples: ConfigurableFileCollection

List of directories or files that contain sample functions which are referenced via @sample KDoc tag.

skipDeprecated

@Input

val skipDeprecated: Property<Boolean>

Whether to document declarations annotated with Deprecated.

skipEmptyPackages

@Input

val skipEmptyPackages: Property<Boolean>

Whether to skip packages that contain no visible declarations after various filters have been applied.

sourceLinks

val sourceLinks: SetProperty<GradleSourceLinkBuilder>

Specifies the location of the project source code on the Web. If provided, Dokka generates "source" links for each declaration. See GradleSourceLinkBuilder for more details.

sourceRoots

@InputFiles

@PathSensitive(value = PathSensitivity.RELATIVE)

val sourceRoots: ConfigurableFileCollection

Source code roots to be analyzed and documented. Accepts directories and individual .kt / .java files.

sourceSetID

@Input

val sourceSetID: DokkaSourceSetID

suppress

@Input

val suppress: Property<Boolean>

Whether this source set should be skipped when generating documentation.

suppressedFiles

@InputFiles

@PathSensitive(value = PathSensitivity.RELATIVE)

val suppressedFiles: ConfigurableFileCollection

Directories or individual files that should be suppressed, meaning declarations from them will be not documented.

suppressGeneratedFiles

@Input

val suppressGeneratedFiles: Property<Boolean>

Whether to document/analyze generated files.

Extensions

configureWithKotlinSourceSet

fun GradleDokkaSourceSetBuilder.configureWithKotlinSourceSet(sourceSet: KotlinSourceSet)

dependsOn

fun GradleDokkaSourceSetBuilder.dependsOn(sourceSet: KotlinSourceSet)

fun GradleDokkaSourceSetBuilder.dependsOn(sourceSet: AndroidSourceSet)

Convenient override to append source sets to GradleDokkaSourceSetBuilder.dependentSourceSets

kotlinSourceSet

fun GradleDokkaSourceSetBuilder.kotlinSourceSet(kotlinSourceSet: KotlinSourceSet)

Extension allowing configuration of Dokka source sets via Kotlin Gradle plugin source sets.