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

AbstractDokkaMojo

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

Constructors

AbstractDokkaMojo

fun AbstractDokkaMojo(defaultDokkaPlugins: List<Dependency>)

Types

PackageOptions

class PackageOptions : DokkaConfiguration.PackageOptions

Functions

execute

open override fun execute()

getLog

open override fun getLog(): Log

getPluginContext

open override fun getPluginContext(): MutableMap<Any?, Any?>

setLog

open override fun setLog(p0: Log)

setPluginContext

open override fun setPluginContext(p0: MutableMap<Any?, Any?>)

Properties

apiVersion

@Parameter

var apiVersion: String? = null

cacheRoot

@Parameter

var cacheRoot: String? = null

classpath

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

var classpath: List<String>

displayName

@Parameter(defaultValue = "JVM")

var displayName: String

documentedVisibilities

@Parameter(property = "visibility")

var documentedVisibilities: Set<DokkaConfiguration.Visibility>

dokkaPlugins

@Parameter

var dokkaPlugins: List<Dependency>

externalDocumentationLinks

@Parameter

var externalDocumentationLinks: List<ExternalDocumentationLinkBuilder>

failOnWarning

@Parameter

var failOnWarning: Boolean

includeNonPublic

@Parameter

var includeNonPublic: Boolean

includes

@Parameter

var includes: List<String>

jdkVersion

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

var jdkVersion: Int

languageVersion

@Parameter

var languageVersion: String? = null

moduleName

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

var moduleName: String

noJdkLink

@Parameter(defaultValue = "false")

var noJdkLink: Boolean

noStdlibLink

@Parameter(defaultValue = "false")

var noStdlibLink: Boolean

offlineMode

@Parameter(defaultValue = "false")

var offlineMode: Boolean

perPackageOptions

@Parameter

var perPackageOptions: List<AbstractDokkaMojo.PackageOptions>

platform

@Parameter

var platform: String

reportUndocumented

@Parameter

var reportUndocumented: Boolean

samples

@Parameter

var samples: List<String>

skip

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

var skip: Boolean = false

skipDeprecated

@Parameter

var skipDeprecated: Boolean

skipEmptyPackages

@Parameter

var skipEmptyPackages: Boolean

sourceDirectories

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

var sourceDirectories: List<String>

sourceLinks

@Parameter

var sourceLinks: List<SourceLinkMapItem>

sourceSetName

@Parameter

var sourceSetName: String

suppressedFiles

@Parameter

var suppressedFiles: List<String>

suppressInheritedMembers

@Parameter(defaultValue = "false")

var suppressInheritedMembers: Boolean

suppressObviousFunctions

@Parameter(defaultValue = "true")

var suppressObviousFunctions: Boolean

Inheritors

DokkaMojo

DokkaJavadocMojo

DokkaJavadocJarMojo