maven-plugin/org.jetbrains.dokka.maven/DokkaMojo

DokkaMojo

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

class DokkaMojo : AbstractDokkaMojo

Constructors

DokkaMojo

fun DokkaMojo()

Functions

execute

open override fun execute()

Properties

apiVersion

@Parameter

var apiVersion: String? = null

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

cacheRoot

@Parameter

var cacheRoot: String? = null

classpath

@Parameter(required = true, defaultValue = "${project.compileClasspathElements}")

var classpath: List<String>

Classpath for analysis and interactive samples.

displayName

@Parameter(defaultValue = "JVM")

var displayName: String

documentedVisibilities

@Parameter(property = "visibility")

var documentedVisibilities: Set<DokkaConfiguration.Visibility>

Set of visibility modifiers that should be documented.

dokkaPlugins

@Parameter

var dokkaPlugins: List<Dependency>

Dokka plugins to be using during documentation generation.

externalDocumentationLinks

@Parameter

var externalDocumentationLinks: List<ExternalDocumentationLinkBuilder>

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

failOnWarning

@Parameter

var failOnWarning: Boolean

Whether to fail documentation generation if Dokka has emitted a warning or an error. Will wait until all errors and warnings have been emitted first.

includeNonPublic

@Parameter

var includeNonPublic: Boolean

Deprecated. Use documentedVisibilities instead.

includes

@Parameter

var includes: List<String>

List of Markdown files that contain module and package documentation.

jdkVersion

@Parameter(required = false, defaultValue = "8")

var jdkVersion: Int

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

languageVersion

@Parameter

var languageVersion: String? = null

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

log

var log: Log

moduleName

@Parameter(required = true, defaultValue = "${project.artifactId}")

var moduleName: String

Display name used to refer to the project/module. Used for ToC, navigation, logging, etc.

noJdkLink

@Parameter(defaultValue = "false")

var noJdkLink: Boolean

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

noStdlibLink

@Parameter(defaultValue = "false")

var noStdlibLink: Boolean

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

offlineMode

@Parameter(defaultValue = "false")

var offlineMode: Boolean

Whether to resolve remote files/links over network.

outputDir

@Parameter(required = true, defaultValue = "${project.basedir}/target/dokka")

var outputDir: String

Directory to which documentation will be generated.

perPackageOptions

@Parameter

var perPackageOptions: List<PackageOptions>

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

platform

@Parameter

var platform: String

pluginContext

var pluginContext: MutableMap<Any?, Any?>

reportUndocumented

@Parameter

var reportUndocumented: Boolean

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

samples

@Parameter

var samples: List<String>

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

skip

@Parameter(required = false, defaultValue = "false")

var skip: Boolean = false

Whether to skip documentation generation.

skipDeprecated

@Parameter

var skipDeprecated: Boolean

Whether to document declarations annotated with Deprecated.

skipEmptyPackages

@Parameter

var skipEmptyPackages: Boolean

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

sourceDirectories

@Parameter(required = true, defaultValue = "${project.compileSourceRoots}")

var sourceDirectories: List<String>

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

sourceLinks

@Parameter

var sourceLinks: List<SourceLinkMapItem>

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

sourceSetName

@Parameter

var sourceSetName: String

suppressedFiles

@Parameter

var suppressedFiles: List<String>

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

suppressInheritedMembers

@Parameter(defaultValue = "false")

var suppressInheritedMembers: Boolean

Whether to suppress inherited members that aren't explicitly overridden in a given class.

suppressObviousFunctions

@Parameter(defaultValue = "true")

var suppressObviousFunctions: Boolean

Whether to suppress obvious functions.