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

GradleDokkaSourceSetBuilder

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

Constructors

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)

DokkaSourceSetID

fun DokkaSourceSetID(sourceSetName: String): DokkaSourceSetID

externalDocumentationLink

fun externalDocumentationLink(c: Closure<in GradleExternalDocumentationLinkBuilder>)

fun externalDocumentationLink(action: Action<in GradleExternalDocumentationLinkBuilder>)

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

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

perPackageOption

fun perPackageOption(c: Closure<in GradlePackageOptionsBuilder>)

fun perPackageOption(action: Action<in GradlePackageOptionsBuilder>)

sourceLink

fun sourceLink(c: Closure<in GradleSourceLinkBuilder>)

fun sourceLink(action: Action<in GradleSourceLinkBuilder>)

sourceRoot

fun sourceRoot(file: File)

fun sourceRoot(path: String)

Properties

apiVersion

@Input

@Optional

val apiVersion: Property<String?>

classpath

@Classpath

@Optional

val classpath: ConfigurableFileCollection

dependentSourceSets

@Input

val dependentSourceSets: SetProperty<DokkaSourceSetID>

displayName

@Input

@Optional

val displayName: Property<String?>

documentedVisibilities

@Input

val documentedVisibilities: SetProperty<DokkaConfiguration.Visibility>

externalDocumentationLinks

val externalDocumentationLinks: SetProperty<GradleExternalDocumentationLinkBuilder>

includeNonPublic

@Input

val includeNonPublic: Property<Boolean>

includes

@InputFiles

@Optional

@PathSensitive(value = PathSensitivity.RELATIVE)

val includes: ConfigurableFileCollection

jdkVersion

@Input

val jdkVersion: Property<Int>

languageVersion

@Input

@Optional

val languageVersion: Property<String?>

name

@Transient

@get:Input

val name: String

noAndroidSdkLink

@Input

val noAndroidSdkLink: Property<Boolean>

noJdkLink

@Input

val noJdkLink: Property<Boolean>

noStdlibLink

@Input

val noStdlibLink: Property<Boolean>

perPackageOptions

val perPackageOptions: ListProperty<GradlePackageOptionsBuilder>

platform

@Input

@Optional

val platform: Property<Platform>

reportUndocumented

@Input

val reportUndocumented: Property<Boolean>

samples

@InputFiles

@Optional

@PathSensitive(value = PathSensitivity.RELATIVE)

val samples: ConfigurableFileCollection

skipDeprecated

@Input

val skipDeprecated: Property<Boolean>

skipEmptyPackages

@Input

val skipEmptyPackages: Property<Boolean>

sourceLinks

val sourceLinks: SetProperty<GradleSourceLinkBuilder>

sourceRoots

@InputFiles

@PathSensitive(value = PathSensitivity.RELATIVE)

val sourceRoots: ConfigurableFileCollection

sourceSetID

@Input

val sourceSetID: DokkaSourceSetID

suppress

@Input

val suppress: Property<Boolean>

suppressedFiles

@InputFiles

@PathSensitive(value = PathSensitivity.RELATIVE)

val suppressedFiles: ConfigurableFileCollection

suppressGeneratedFiles

@Input

val suppressGeneratedFiles: Property<Boolean>

Extensions

configureWithKotlinSourceSet

fun GradleDokkaSourceSetBuilder.configureWithKotlinSourceSet(sourceSet: KotlinSourceSet)

dependsOn

fun GradleDokkaSourceSetBuilder.dependsOn(sourceSet: KotlinSourceSet)

fun GradleDokkaSourceSetBuilder.dependsOn(sourceSet: AndroidSourceSet)

kotlinSourceSet

fun GradleDokkaSourceSetBuilder.kotlinSourceSet(kotlinSourceSet: KotlinSourceSet)