api / org.gradle.external.javadoc / MinimalJavadocOptions

MinimalJavadocOptions

interface MinimalJavadocOptions

Provides the core Javadoc options.

Functions

bootClasspath	`abstract fun bootClasspath(vararg bootClasspath: File): MinimalJavadocOptions`
breakIterator	`abstract fun breakIterator(breakIterator: Boolean): MinimalJavadocOptions` `abstract fun breakIterator(): MinimalJavadocOptions`
classpath	`abstract fun classpath(classpath: MutableList<File>): MinimalJavadocOptions` `abstract fun classpath(vararg classpath: File): MinimalJavadocOptions`
contributeCommandLineOptions	`abstract fun contributeCommandLineOptions(execHandleBuilder: ExecSpec): Unit`
destinationDirectory	`abstract fun destinationDirectory(directory: File): MinimalJavadocOptions`
doclet	`abstract fun doclet(docletClass: String): MinimalJavadocOptions`
docletpath	`abstract fun docletpath(vararg docletpath: File): MinimalJavadocOptions`
encoding	`abstract fun encoding(encoding: String): MinimalJavadocOptions`
extDirs	`abstract fun extDirs(vararg extDirs: File): MinimalJavadocOptions`
getBootClasspath	`abstract fun getBootClasspath(): MutableList<File>`
getClasspath	`abstract fun getClasspath(): MutableList<File>`
getDestinationDirectory	`abstract fun getDestinationDirectory(): File`
getDoclet	`abstract fun getDoclet(): String`
getDocletpath	`abstract fun getDocletpath(): MutableList<File>`
getEncoding	`abstract fun getEncoding(): String`
getExtDirs	`abstract fun getExtDirs(): MutableList<File>`
getHeader	`abstract fun getHeader(): String`
getJFlags	`abstract fun getJFlags(): MutableList<String>`
getLocale	`abstract fun getLocale(): String`
getMemberLevel	`abstract fun getMemberLevel(): JavadocMemberLevel`
getOptionFiles	`abstract fun getOptionFiles(): MutableList<File>`
getOutputLevel	`abstract fun getOutputLevel(): JavadocOutputLevel`
getOverview	`abstract fun getOverview(): String`
getSource	`abstract fun getSource(): String`
getSourceNames	`abstract fun getSourceNames(): MutableList<String>`
getWindowTitle	`abstract fun getWindowTitle(): String`
header	`abstract fun header(header: String): StandardJavadocDocletOptions`
isBreakIterator	`abstract fun isBreakIterator(): Boolean`
isVerbose	`abstract fun isVerbose(): Boolean`
jFlags	`abstract fun jFlags(vararg jFlags: String): MinimalJavadocOptions`
locale	`abstract fun locale(locale: String): MinimalJavadocOptions`
optionFiles	`abstract fun optionFiles(vararg argumentFiles: File): MinimalJavadocOptions`
overview	`abstract fun overview(overview: String): MinimalJavadocOptions`
quiet	`abstract fun quiet(): MinimalJavadocOptions`
setBootClasspath	`abstract fun setBootClasspath(bootClasspath: MutableList<File>): Unit`
setBreakIterator	`abstract fun setBreakIterator(breakIterator: Boolean): Unit`
setClasspath	`abstract fun setClasspath(classpath: MutableList<File>): Unit`
setDestinationDirectory	`abstract fun setDestinationDirectory(directory: File): Unit`
setDoclet	`abstract fun setDoclet(docletClass: String): Unit`
setDocletpath	`abstract fun setDocletpath(docletpath: MutableList<File>): Unit`
setEncoding	`abstract fun setEncoding(encoding: String): Unit`
setExtDirs	`abstract fun setExtDirs(extDirs: MutableList<File>): Unit`
setHeader	`abstract fun setHeader(header: String): Unit`
setJFlags	`abstract fun setJFlags(jFlags: MutableList<String>): Unit`
setLocale	`abstract fun setLocale(locale: String): Unit`
setMemberLevel	`abstract fun setMemberLevel(memberLevel: JavadocMemberLevel): Unit`
setOptionFiles	`abstract fun setOptionFiles(optionFiles: MutableList<File>): Unit`
setOutputLevel	`abstract fun setOutputLevel(outputLevel: JavadocOutputLevel): Unit`
setOverview	`abstract fun setOverview(overview: String): Unit`
setSource	`abstract fun setSource(source: String): Unit`
setSourceNames	`abstract fun setSourceNames(sourceNames: MutableList<String>): Unit`
setWindowTitle	`abstract fun setWindowTitle(windowTitle: String): Unit`
showAll	`abstract fun showAll(): MinimalJavadocOptions`
showFromPackage	`abstract fun showFromPackage(): MinimalJavadocOptions`
showFromPrivate	`abstract fun showFromPrivate(): MinimalJavadocOptions`
showFromProtected	`abstract fun showFromProtected(): MinimalJavadocOptions`
showFromPublic	`abstract fun showFromPublic(): MinimalJavadocOptions`
source	`abstract fun source(source: String): MinimalJavadocOptions`
sourceNames	`abstract fun sourceNames(vararg sourceNames: String): MinimalJavadocOptions`
verbose	`abstract fun verbose(): MinimalJavadocOptions`
windowTitle	`abstract fun windowTitle(windowTitle: String): StandardJavadocDocletOptions`
write	`abstract fun write(outputFile: File): Unit`

Inheritors

CoreJavadocOptions	`abstract class CoreJavadocOptions : MinimalJavadocOptions` Provides the core Javadoc Options. That is, provides the options which are not doclet specific.
StandardJavadocDocletOptions	`open class StandardJavadocDocletOptions : CoreJavadocOptions, MinimalJavadocOptions` Provides the options for the standard Javadoc doclet.