Index

A C D E F G H I J L M N O P R S V W
All Classes and Interfaces|All Packages|Constant Field Values

A

analysisPlatform(AnalysisPlatform) - Method in class rife.bld.extension.dokka.SourceSet: Sets the platform used for setting up analysis.
AnalysisPlatform - Enum Class in rife.bld.extension.dokka: Dokka's analysis platforms.
ANDROID - Enum constant in enum class rife.bld.extension.dokka.AnalysisPlatform
apiVersion(int) - Method in class rife.bld.extension.dokka.SourceSet: Sets the Kotlin API version used for setting up analysis and samples.
apiVersion(String) - Method in class rife.bld.extension.dokka.SourceSet: Sets the Kotlin API version used for setting up analysis and samples.
args() - Method in class rife.bld.extension.dokka.SourceSet: Returns the formatted arguments.

C

classpath() - Method in class rife.bld.extension.dokka.SourceSet: Retrieves the classpath for analysis and interactive samples.
classpath(File...) - Method in class rife.bld.extension.dokka.SourceSet: Sets classpath for analysis and interactive samples.
classpath(String...) - Method in class rife.bld.extension.dokka.SourceSet: Sets classpath for analysis and interactive samples.
classpath(Path...) - Method in class rife.bld.extension.dokka.SourceSet: Sets classpath for analysis and interactive samples.
classpath(Collection<File>) - Method in class rife.bld.extension.dokka.SourceSet: Sets classpath for analysis and interactive samples.
classpathPaths(Collection<Path>) - Method in class rife.bld.extension.dokka.SourceSet: Sets classpath for analysis and interactive samples.
classpathStrings(Collection<String>) - Method in class rife.bld.extension.dokka.SourceSet: Sets classpath for analysis and interactive samples.
COMMON - Enum constant in enum class rife.bld.extension.dokka.AnalysisPlatform

D

DEBUG - Enum constant in enum class rife.bld.extension.dokka.LoggingLevel
delayTemplateSubstitution(Boolean) - Method in class rife.bld.extension.DokkaOperation: Sets the delay substitution of some elements.
dependentSourceSets() - Method in class rife.bld.extension.dokka.SourceSet: Retrieves the names of dependent source sets.
dependentSourceSets(String, String) - Method in class rife.bld.extension.dokka.SourceSet: Sets the names of dependent source sets.
dependentSourceSets(Map<String, String>) - Method in class rife.bld.extension.dokka.SourceSet: Sets the names of dependent source sets.
displayName(String) - Method in class rife.bld.extension.dokka.SourceSet: Sets the display name of the source set, used both internally and externally.
documentedVisibilities() - Method in class rife.bld.extension.dokka.SourceSet: Retrieves the visibilities to be documented.
documentedVisibilities(DocumentedVisibility...) - Method in class rife.bld.extension.dokka.SourceSet: Sets visibilities to be documented.
DocumentedVisibility - Enum Class in rife.bld.extension.dokka: Dokka documented visibilities.
DokkaOperation - Class in rife.bld.extension: Builds documentation (javadoc, HTML, etc.) using Dokka.
DokkaOperation() - Constructor for class rife.bld.extension.DokkaOperation

E

ERROR - Enum constant in enum class rife.bld.extension.dokka.LoggingLevel
execute() - Method in class rife.bld.extension.DokkaOperation
executeConstructProcessCommandList() - Method in class rife.bld.extension.DokkaOperation: Part of the execute operation, constructs the command list to use for building the process.
externalDocumentationLinks() - Method in class rife.bld.extension.dokka.SourceSet: Retrieves the external documentation links.
externalDocumentationLinks(String, String) - Method in class rife.bld.extension.dokka.SourceSet: Sets the external documentation links.
externalDocumentationLinks(Map<String, String>) - Method in class rife.bld.extension.dokka.SourceSet: Sets the external documentation links.

F

failOnWarning(Boolean) - Method in class rife.bld.extension.DokkaOperation: Sets whether to fail documentation generation if Dokka has emitted a warning or an error.
fromProject(BaseProject) - Method in class rife.bld.extension.DokkaOperation: Configures the operation from a BaseProject.

G

getJarList(File, String) - Static method in class rife.bld.extension.DokkaOperation: Returns the JARs contained in a given directory.
globalLinks() - Method in class rife.bld.extension.DokkaOperation: Retrieves the global external documentation links.
globalLinks(String, String) - Method in class rife.bld.extension.DokkaOperation: Set the global external documentation links.
globalLinks(Map<String, String>) - Method in class rife.bld.extension.DokkaOperation: Set the global external documentation links.
globalPackageOptions() - Method in class rife.bld.extension.DokkaOperation: Retrieves the global package configurations.
globalPackageOptions(String...) - Method in class rife.bld.extension.DokkaOperation: Sets the global package configurations.
globalPackageOptions(Collection<String>) - Method in class rife.bld.extension.DokkaOperation: Sets the global package configurations.
globalSrcLink() - Method in class rife.bld.extension.DokkaOperation: Retrieves the global source links
globalSrcLink(String...) - Method in class rife.bld.extension.DokkaOperation: Sets the global mapping between a source directory and a Web service for browsing the code.
globalSrcLink(Collection<String>) - Method in class rife.bld.extension.DokkaOperation: Sets the global mapping between a source directory and a Web service for browsing the code.

H

HTML - Enum constant in enum class rife.bld.extension.dokka.OutputFormat

I

includes() - Method in class rife.bld.extension.dokka.SourceSet: Retrieves the Markdown files that contain module and package documentation.
includes() - Method in class rife.bld.extension.DokkaOperation: Retrieves the markdown files that contain the module and package documentation.
includes(File...) - Method in class rife.bld.extension.dokka.SourceSet: Sets the Markdown files that contain module and package documentation.
includes(File...) - Method in class rife.bld.extension.DokkaOperation: Sets the Markdown files that contain module and package documentation.
includes(String...) - Method in class rife.bld.extension.dokka.SourceSet: Sets the Markdown files that contain module and package documentation.
includes(String...) - Method in class rife.bld.extension.DokkaOperation: Sets the Markdown files that contain module and package documentation.
includes(Path...) - Method in class rife.bld.extension.dokka.SourceSet: Sets the Markdown files that contain module and package documentation.
includes(Path...) - Method in class rife.bld.extension.DokkaOperation: Sets the Markdown files that contain module and package documentation.
includes(Collection<File>) - Method in class rife.bld.extension.dokka.SourceSet: Sets the Markdown files that contain module and package documentation.
includes(Collection<File>) - Method in class rife.bld.extension.DokkaOperation: Sets the Markdown files that contain module and package documentation.
includesPaths(Collection<Path>) - Method in class rife.bld.extension.dokka.SourceSet: Sets the Markdown files that contain module and package documentation.
includesPaths(Collection<Path>) - Method in class rife.bld.extension.DokkaOperation: Sets the Markdown files that contain module and package documentation.
includesStrings(Collection<String>) - Method in class rife.bld.extension.dokka.SourceSet: Sets the Markdown files that contain module and package documentation.
includesStrings(Collection<String>) - Method in class rife.bld.extension.DokkaOperation: Sets the Markdown files that contain module and package documentation.
INFO - Enum constant in enum class rife.bld.extension.dokka.LoggingLevel
INTERNAL - Enum constant in enum class rife.bld.extension.dokka.DocumentedVisibility
isNotBlank(String) - Static method in class rife.bld.extension.DokkaOperation: Determines if the given string is not blank.

J

JAVADOC - Enum constant in enum class rife.bld.extension.dokka.OutputFormat
jdkVersion() - Method in class rife.bld.extension.dokka.SourceSet: Retrieves the version of the JDK to use for linking to JDK Javadocs.
jdkVersion(int) - Method in class rife.bld.extension.dokka.SourceSet: Sets the version of JDK to use for linking to JDK Javadocs.
jdkVersion(String) - Method in class rife.bld.extension.dokka.SourceSet: Sets the version of JDK to use for linking to JDK Javadocs.
JEKYLL - Enum constant in enum class rife.bld.extension.dokka.OutputFormat
JS - Enum constant in enum class rife.bld.extension.dokka.AnalysisPlatform
json() - Method in class rife.bld.extension.DokkaOperation: Retrieves the JSON configuration file path.
json(File) - Method in class rife.bld.extension.DokkaOperation: JSON configuration file path.
json(String) - Method in class rife.bld.extension.DokkaOperation: JSON configuration file path.
json(Path) - Method in class rife.bld.extension.DokkaOperation: JSON configuration file path.
JVM - Enum constant in enum class rife.bld.extension.dokka.AnalysisPlatform

L

languageVersion(int) - Method in class rife.bld.extension.dokka.SourceSet: Sets the language version used for setting up analysis and samples.
languageVersion(String) - Method in class rife.bld.extension.dokka.SourceSet: Sets the language version used for setting up analysis and samples.
loggingLevel(LoggingLevel) - Method in class rife.bld.extension.DokkaOperation: Sets the logging level.
LoggingLevel - Enum Class in rife.bld.extension.dokka: Dokka logging levels.

M

MARKDOWN - Enum constant in enum class rife.bld.extension.dokka.OutputFormat
moduleName(String) - Method in class rife.bld.extension.DokkaOperation: Sets the name of the project/module.
moduleVersion(String) - Method in class rife.bld.extension.DokkaOperation: Set the documented version.

N

NATIVE - Enum constant in enum class rife.bld.extension.dokka.AnalysisPlatform
noJdkLink(Boolean) - Method in class rife.bld.extension.dokka.SourceSet: Sets whether to generate links to JDK Javadocs.
noSkipEmptyPackages(boolean) - Method in class rife.bld.extension.dokka.SourceSet: Sets whether to create pages for empty packages.
noStdlibLink(Boolean) - Method in class rife.bld.extension.dokka.SourceSet: Sets whether to generate links to Standard library.
noSuppressObviousFunctions(Boolean) - Method in class rife.bld.extension.DokkaOperation: Sets whether to suppress obvious functions such as inherited from kotlin.Any and Object.

O

offlineMode(Boolean) - Method in class rife.bld.extension.DokkaOperation: Sets whether to resolve remote files/links over network.
outputDir() - Method in class rife.bld.extension.DokkaOperation: Retrieves the output directory path.
outputDir(File) - Method in class rife.bld.extension.DokkaOperation: Sets the output directory path, ./dokka by default.
outputDir(String) - Method in class rife.bld.extension.DokkaOperation: Sets the output directory path, ./dokka by default.
outputDir(Path) - Method in class rife.bld.extension.DokkaOperation: Sets the output directory path, ./dokka by default.
outputFormat(OutputFormat) - Method in class rife.bld.extension.DokkaOperation: Sets the Dokka output format.
OutputFormat - Enum Class in rife.bld.extension.dokka: Dokka output formats.

P

PACKAGE - Enum constant in enum class rife.bld.extension.dokka.DocumentedVisibility
perPackageOptions() - Method in class rife.bld.extension.dokka.SourceSet: Retrieves the package source set configuration.
perPackageOptions(String...) - Method in class rife.bld.extension.dokka.SourceSet: Set the package source set configuration.
perPackageOptions(Collection<String>) - Method in class rife.bld.extension.dokka.SourceSet: Set the package source set configuration.
pluginConfigurations() - Method in class rife.bld.extension.DokkaOperation: Retrieves the plugin configurations.
pluginConfigurations(String, String) - Method in class rife.bld.extension.DokkaOperation: Sets the configuration for Dokka plugins.
pluginConfigurations(Map<String, String>) - Method in class rife.bld.extension.DokkaOperation: Sets the configuration for Dokka plugins.
pluginsClasspath() - Method in class rife.bld.extension.DokkaOperation: Retrieves the plugins classpath.
pluginsClasspath(File...) - Method in class rife.bld.extension.DokkaOperation: Sets the jars for Dokka plugins and their dependencies.
pluginsClasspath(String...) - Method in class rife.bld.extension.DokkaOperation: Sets the jars for Dokka plugins and their dependencies.
pluginsClasspath(Path...) - Method in class rife.bld.extension.DokkaOperation: Sets the jars for Dokka plugins and their dependencies.
pluginsClasspath(Collection<File>) - Method in class rife.bld.extension.DokkaOperation: Sets the jars for Dokka plugins and their dependencies.
pluginsClasspathPaths(Collection<Path>) - Method in class rife.bld.extension.DokkaOperation: Sets the jars for Dokka plugins and their dependencies.
pluginsClasspathStrings(Collection<String>) - Method in class rife.bld.extension.DokkaOperation: Sets the jars for Dokka plugins and their dependencies.
PRIVATE - Enum constant in enum class rife.bld.extension.dokka.DocumentedVisibility
PROGRESS - Enum constant in enum class rife.bld.extension.dokka.LoggingLevel
PROTECTED - Enum constant in enum class rife.bld.extension.dokka.DocumentedVisibility
PUBLIC - Enum constant in enum class rife.bld.extension.dokka.DocumentedVisibility

R

reportUndocumented(Boolean) - Method in class rife.bld.extension.dokka.SourceSet: Sets whether to report undocumented declarations.
rife.bld.extension - package rife.bld.extension
rife.bld.extension.dokka - package rife.bld.extension.dokka

S

samples() - Method in class rife.bld.extension.dokka.SourceSet: Retrieves the directories or files that contain sample functions.
samples(File...) - Method in class rife.bld.extension.dokka.SourceSet: Set the directories or files that contain sample functions.
samples(String...) - Method in class rife.bld.extension.dokka.SourceSet: Set the directories or files that contain sample functions.
samples(Path...) - Method in class rife.bld.extension.dokka.SourceSet: Set the directories or files that contain sample functions.
samples(Collection<File>) - Method in class rife.bld.extension.dokka.SourceSet: Set the directories or files that contain sample functions.
samplesPaths(Collection<Path>) - Method in class rife.bld.extension.dokka.SourceSet: Set the directories or files that contain sample functions.
samplesStrings(Collection<String>) - Method in class rife.bld.extension.dokka.SourceSet: Set the directories or files that contain sample functions.
SEMICOLON - Static variable in class rife.bld.extension.DokkaOperation
skipDeprecated(boolean) - Method in class rife.bld.extension.dokka.SourceSet: Sets whether to skip deprecated declarations.
sourceSet(SourceSet) - Method in class rife.bld.extension.DokkaOperation: Sets the configurations for a source set.
SourceSet - Class in rife.bld.extension.dokka: Configuration for a Dokka source set.
SourceSet() - Constructor for class rife.bld.extension.dokka.SourceSet
sourceSetName(String) - Method in class rife.bld.extension.dokka.SourceSet: Sets the name of the source set.
src() - Method in class rife.bld.extension.dokka.SourceSet: Retrieves the source code roots to be analyzed and documented.
src(File...) - Method in class rife.bld.extension.dokka.SourceSet: Sets the source code roots to be analyzed and documented.
src(String...) - Method in class rife.bld.extension.dokka.SourceSet: Sets the source code roots to be analyzed and documented.
src(Path...) - Method in class rife.bld.extension.dokka.SourceSet: Sets the source code roots to be analyzed and documented.
src(Collection<File>) - Method in class rife.bld.extension.dokka.SourceSet: Sets the source code roots to be analyzed and documented.
srcLink(File, String, String) - Method in class rife.bld.extension.dokka.SourceSet: Sets the mapping between a source directory and a Web service for browsing the code.
srcLink(String, String, String) - Method in class rife.bld.extension.dokka.SourceSet: Sets the mapping between a source directory and a Web service for browsing the code.
srcLink(Path, String, String) - Method in class rife.bld.extension.dokka.SourceSet: Sets the mapping between a source directory and a Web service for browsing the code.
srcLinks() - Method in class rife.bld.extension.dokka.SourceSet: Retrieves the mapping between a source directory and a Web service for browsing the code.
srcPaths(Collection<Path>) - Method in class rife.bld.extension.dokka.SourceSet: Sets the source code roots to be analyzed and documented.
srcStrings(Collection<String>) - Method in class rife.bld.extension.dokka.SourceSet: Sets the source code roots to be analyzed and documented.
suppressedFiles() - Method in class rife.bld.extension.dokka.SourceSet: Retrieves the paths to files to be suppressed.
suppressedFiles(File...) - Method in class rife.bld.extension.dokka.SourceSet: Sets the paths to files to be suppressed.
suppressedFiles(String...) - Method in class rife.bld.extension.dokka.SourceSet: Sets the paths to files to be suppressed.
suppressedFiles(Path...) - Method in class rife.bld.extension.dokka.SourceSet: Sets the paths to files to be suppressed.
suppressedFiles(Collection<File>) - Method in class rife.bld.extension.dokka.SourceSet: Sets the paths to files to be suppressed.
suppressedFilesPaths(Collection<Path>) - Method in class rife.bld.extension.dokka.SourceSet: Sets the paths to files to be suppressed.
suppressedFilesStrings(Collection<String>) - Method in class rife.bld.extension.dokka.SourceSet: Sets the paths to files to be suppressed.
suppressInheritedMembers(Boolean) - Method in class rife.bld.extension.DokkaOperation: Sets whether to suppress inherited members that aren't explicitly overridden in a given class.

V

valueOf(String) - Static method in enum class rife.bld.extension.dokka.AnalysisPlatform: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class rife.bld.extension.dokka.DocumentedVisibility: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class rife.bld.extension.dokka.LoggingLevel: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class rife.bld.extension.dokka.OutputFormat: Returns the enum constant of this class with the specified name.
values() - Static method in enum class rife.bld.extension.dokka.AnalysisPlatform: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class rife.bld.extension.dokka.DocumentedVisibility: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class rife.bld.extension.dokka.LoggingLevel: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class rife.bld.extension.dokka.OutputFormat: Returns an array containing the constants of this enum class, in the order they are declared.

W

WARN - Enum constant in enum class rife.bld.extension.dokka.LoggingLevel

A C D E F G H I J L M N O P R S V W
All Classes and Interfaces|All Packages|Constant Field Values