gradle-plugin/org.jetbrains.dokka.gradle

Package org.jetbrains.dokka.gradle

Types

Link copied to clipboard
@DisableCachingByDefault(because = "Abstract super-class, not to be instantiated directly")
abstract class AbstractDokkaLeafTask : AbstractDokkaTask
Content copied to clipboard
Link copied to clipboard
@DisableCachingByDefault(because = "Abstract super-class, not to be instantiated directly")
abstract class AbstractDokkaParentTask : AbstractDokkaTask
Content copied to clipboard
Link copied to clipboard
@DisableCachingByDefault(because = "Abstract super-class, not to be instantiated directly")
abstract class AbstractDokkaTask : DefaultTask
Content copied to clipboard
Link copied to clipboard
@CacheableTask
abstract class DokkaCollectorTask : AbstractDokkaParentTask
Content copied to clipboard
Link copied to clipboard
fun interface DokkaMultiModuleFileLayout
Content copied to clipboard
Link copied to clipboard
typealias DokkaMultimoduleTask = DokkaMultiModuleTask
Content copied to clipboard
Link copied to clipboard
open class DokkaPlugin : Plugin<Project>
Content copied to clipboard
Link copied to clipboard
@CacheableTask
abstract class DokkaTask : AbstractDokkaLeafTask
Content copied to clipboard
Link copied to clipboard
@CacheableTask
abstract class DokkaTaskPartial : AbstractDokkaLeafTask
Content copied to clipboard
Link copied to clipboard
open class GradleDokkaSourceSetBuilder(    val name: String,     project: Project,     sourceSetIdFactory: NamedDomainObjectFactory<DokkaSourceSetID>) : DokkaConfigurationBuilder<DokkaSourceSetImpl>
Content copied to clipboard

Source set level configuration.

Link copied to clipboard
class GradleExternalDocumentationLinkBuilder(project: Project) : DokkaConfigurationBuilder<ExternalDocumentationLinkImpl>
Content copied to clipboard

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

Link copied to clipboard
class GradlePackageOptionsBuilder(project: Project) : DokkaConfigurationBuilder<PackageOptionsImpl>
Content copied to clipboard

Configuration builder that allows setting some options for specific packages matched by matchingRegex.

Link copied to clipboard
class GradleSourceLinkBuilder(project: Project) : DokkaConfigurationBuilder<SourceLinkDefinitionImpl>
Content copied to clipboard

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.

Functions

Link copied to clipboard
fun GradleDokkaSourceSetBuilder.configureWithKotlinSourceSet(sourceSet: KotlinSourceSet)
Content copied to clipboard
Link copied to clipboard
fun GradleDokkaSourceSetBuilder.dependsOn(sourceSet: AndroidSourceSet)
Content copied to clipboard
fun GradleDokkaSourceSetBuilder.dependsOn(sourceSet: KotlinSourceSet)
Content copied to clipboard

Convenient override to append source sets to GradleDokkaSourceSetBuilder.dependentSourceSets

Link copied to clipboard
fun DokkaBootstrap(configuration: Configuration, bootstrapClass: KClass<out DokkaBootstrap>): DokkaBootstrap
Content copied to clipboard
Link copied to clipboard
fun AbstractDokkaTask.gradleDokkaSourceSetBuilderFactory(): NamedDomainObjectFactory<GradleDokkaSourceSetBuilder>
Content copied to clipboard
Link copied to clipboard
fun GradleDokkaSourceSetBuilder.kotlinSourceSet(kotlinSourceSet: KotlinSourceSet)
Content copied to clipboard

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