gradle-plugin/org.jetbrains.dokka.gradle

Package-level declarations

Types

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

Source set level configuration.

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

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

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

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

Link copied to clipboard
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.

Functions

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

Convenient override to append source sets to GradleDokkaSourceSetBuilder.dependentSourceSets

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

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