maven-plugin/org.jetbrains.dokka.maven

Package-level declarations

Types

abstract class AbstractDokkaMojo(defaultDokkaPlugins: List<Dependency>) : AbstractMojo

@Mojo(name = "javadocJar", defaultPhase = LifecyclePhase.PRE_SITE, threadSafe = true, requiresDependencyResolution = ResolutionScope.COMPILE, requiresProject = true)

class DokkaJavadocJarMojo : AbstractDokkaMojo

DokkaJavadocMojo

@Mojo(name = "javadoc", defaultPhase = LifecyclePhase.PRE_SITE, threadSafe = true, requiresDependencyResolution = ResolutionScope.COMPILE, requiresProject = true)

class DokkaJavadocMojo : AbstractDokkaMojo

DokkaMojo

@Mojo(name = "dokka", defaultPhase = LifecyclePhase.PRE_SITE, threadSafe = true, requiresDependencyResolution = ResolutionScope.COMPILE, requiresProject = true)

class DokkaMojo : AbstractDokkaMojo

ExternalDocumentationLinkBuilder

class ExternalDocumentationLinkBuilder

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

MavenDokkaLogger

class MavenDokkaLogger(val log: Log) : DokkaLogger

PackageOptions

class PackageOptions : DokkaConfiguration.PackageOptions

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

SourceLinkMapItem

class SourceLinkMapItem

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