Class DokkaOperation
- Since:
- 1.0
- Author:
- Erik C. Thauvin
-
Field Summary
Fields inherited from class rife.bld.operations.AbstractProcessOperation
classpath_, DEFAULT_JAVA_TOOL, errorProcessor_, errorProcessorThread_, javaOptions_, javaTool_, mainClass_, outputProcessor_, outputProcessorThread_, process_, successful_, workDirectory_
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptiondelayTemplateSubstitution
(Boolean delayTemplateSubstitution) Sets the delay substitution of some elements.Part of theexecute
operation, constructs the command list to use for building the process.failOnWarning
(Boolean failOnWarning) Sets whether to fail documentation generation if Dokka has emitted a warning or an error.fromProject
(BaseProject project) Configures the operation from aBaseProject
.globalLinks
(String url, String packageListUrl) Set the global external documentation links.globalLinks
(Map<String, String> globalLinks) Set the global external documentation links.globalPackageOptions
(String... options) Sets the global list of package configurations.globalPackageOptions
(Collection<String> options) Sets the global list of package configurations.globalSrcLink
(String... links) Sets the global mapping between a source directory and a Web service for browsing the code.globalSrcLink
(Collection<String> links) Sets the global mapping between a source directory and a Web service for browsing the code.Sets the Markdown files that contain module and package documentation.includes
(Collection<String> files) Sets the Markdown files that contain module and package documentation.loggingLevel
(LoggingLevel loggingLevel) Sets the logging level.moduleName
(String moduleName) Sets the name of the project/module.moduleVersion
(String version) Set the documented version.noSuppressObviousFunctions
(Boolean noSuppressObviousFunctions) Sets whether to suppress obvious functions such as inherited from kotlin.Any andObject
.offlineMode
(Boolean offlineMode) Sets whether to resolve remote files/links over network.Sets the output directory path,./dokka
by default.Sets the output directory path,./dokka
by default.outputFormat
(OutputFormat format) Sets the Dokkaoutput format
.pluginConfiguration
(String name, String jsonConfiguration) Sets the configuration for Dokka plugins.pluginConfiguration
(Map<String, String> pluginConfiguration) Sets the configuration for Dokka plugins.pluginsClasspath
(boolean clear) Clears the list of Dokka plugins.pluginsClasspath
(String... jars) Sets the list of jars with Dokka plugins and their dependencies.pluginsClasspath
(Collection<String> jars) Sets the list of jars with Dokka plugins and their dependencies.Sets the configurations for a source set.suppressInheritedMembers
(Boolean suppressInheritedMembers) Sets whether to suppress inherited members that aren't explicitly overridden in a given class.Methods inherited from class rife.bld.operations.AbstractProcessOperation
classpath, classpath, classpath, errorProcessor, errorProcessor, execute, executeStartProcess, javaOptions, javaOptions, javaTool, javaTool, mainClass, mainClass, outputProcessor, outputProcessor, process, workDirectory, workDirectory
Methods inherited from class rife.bld.operations.AbstractOperation
executeOnce, executeOnce, silent, silent
-
Constructor Details
-
DokkaOperation
public DokkaOperation()
-
-
Method Details
-
delayTemplateSubstitution
Sets the delay substitution of some elements.Used in incremental builds of multimodule projects.
- Parameters:
delayTemplateSubstitution
- the delay- Returns:
- this operation instance
-
executeConstructProcessCommandList
Part of theexecute
operation, constructs the command list to use for building the process.- Specified by:
executeConstructProcessCommandList
in classAbstractProcessOperation<DokkaOperation>
- Since:
- 1.5
-
fromProject
Configures the operation from aBaseProject
.Sets the
sourceSet
,jdkVersion
andmoduleName
from the project.- Specified by:
fromProject
in classAbstractProcessOperation<DokkaOperation>
- Parameters:
project
- the project to configure the operation from
-
failOnWarning
Sets whether to fail documentation generation if Dokka has emitted a warning or an error.Whether to fail documentation generation if Dokka has emitted a warning or an error. The process waits until all errors and warnings have been emitted first.
This setting works well with
SourceSet.reportUndocumented(java.lang.Boolean)
- Parameters:
failOnWarning
-true
orfalse
- Returns:
- this operation instance
-
globalLinks
Set the global external documentation links.- Parameters:
url
- the external documentation URLpackageListUrl
- the external documentation package list URL- Returns:
- this operation instance
-
globalLinks
Set the global external documentation links.- Parameters:
globalLinks
- the map of global links- Returns:
- this operation instance
- See Also:
-
globalPackageOptions
Sets the global list of package configurations.Using format:
- matchingRegexp
- -deprecated
- -privateApi
- +warnUndocumented
- +suppress
- +visibility:PUBLIC
- ...
- Parameters:
options
- ome pr more package configurations- Returns:
- this operation instance
-
globalPackageOptions
Sets the global list of package configurations.Using format:
- matchingRegexp
- -deprecated
- -privateApi
- +warnUndocumented
- +suppress
- +visibility:PUBLIC
- ...
- Parameters:
options
- the list of package configurations- Returns:
- this operation instance
-
globalSrcLink
Sets the global mapping between a source directory and a Web service for browsing the code.- Parameters:
links
- one or more links mapping- Returns:
- this operation instance
-
globalSrcLink
Sets the global mapping between a source directory and a Web service for browsing the code.- Parameters:
links
- the links mapping- Returns:
- this operation instance
-
includes
Sets the Markdown files that contain module and package documentation.The contents of specified files are parsed and embedded into documentation as module and package descriptions.
This can be configured on per-package basis.
- Parameters:
files
- one or more files- Returns:
- this operation instance
-
includes
Sets the Markdown files that contain module and package documentation.The contents of specified files are parsed and embedded into documentation as module and package descriptions.
This can be configured on per-package basis.
- Parameters:
files
- the list of files- Returns:
- this operation instance
-
loggingLevel
Sets the logging level.- Parameters:
loggingLevel
- the logging level- Returns:
- this operation instance
-
moduleName
Sets the name of the project/module. Default isroot
.The display name used to refer to the module. It is used for the table of contents, navigation, logging, etc.
- Parameters:
moduleName
- the project/module name- Returns:
- this operation instance
-
moduleVersion
Set the documented version.- Parameters:
version
- the version- Returns:
- this operation instance
-
noSuppressObviousFunctions
Sets whether to suppress obvious functions such as inherited from kotlin.Any andObject
.A function is considered to be obvious if it is:
- Inherited from kotlin.Any,
Kotlin.Enum,
Object
orEnum
, such asequals
,hashCode
,toString
. - Synthetic (generated by the compiler) and does not have any documentation, such as
dataClass.componentN
ordataClass.copy
.
- Parameters:
noSuppressObviousFunctions
-true
orfalse
- Returns:
- this operation instance
- Inherited from kotlin.Any,
Kotlin.Enum,
-
offlineMode
Sets whether to resolve remote files/links over network.This includes package-lists used for generating external documentation links. For example, to make classes from the standard library clickable.
Setting this to true can significantly speed up build times in certain cases, but can also worsen documentation quality and user experience. For example, by not resolving class/member links from your dependencies, including the standard library.
Note: You can cache fetched files locally and provide them to Dokka as local paths.
- Parameters:
offlineMode
- the offline mode- Returns:
- this operation instance
- See Also:
-
outputDir
Sets the output directory path,./dokka
by default.The directory to where documentation is generated, regardless of output format.
- Parameters:
outputDir
- the output directory- Returns:
- this operation instance
-
outputDir
Sets the output directory path,./dokka
by default.- Parameters:
outputDir
- the output directory- Returns:
- this operation instance
-
outputFormat
Sets the Dokkaoutput format
.- Parameters:
format
- Theoutput format
- Returns:
- this operation instance
-
pluginConfiguration
Sets the configuration for Dokka plugins.- Parameters:
name
- The fully-qualified plugin namejsonConfiguration
- The plugin JSON configuration- Returns:
- this operation instance
-
pluginConfiguration
Sets the configuration for Dokka plugins.- Parameters:
pluginConfiguration
- the map of configurations- Returns:
- this operation instance
- See Also:
-
pluginsClasspath
Sets the list of jars with Dokka plugins and their dependencies.- Parameters:
jars
- one or more jars- Returns:
- this operation instance
-
pluginsClasspath
Sets the list of jars with Dokka plugins and their dependencies.- Parameters:
jars
- the list of jars- Returns:
- this operation instance
-
pluginsClasspath
Clears the list of Dokka plugins.- Parameters:
clear
- set to clear the list- Returns:
- this operation instance
-
sourceSet
Sets the configurations for a source set.Individual and additional configuration of Kotlin source sets.
- Parameters:
sourceSet
- the source set configurations- Returns:
- this operation instance
-
suppressInheritedMembers
Sets whether to suppress inherited members that aren't explicitly overridden in a given class.- Parameters:
suppressInheritedMembers
-true
orfalse
- Returns:
- this operation instance
-