# MinimalJavadocOptions

interface MinimalJavadocOptions

Provides the core Javadoc options.

#### Inheritors

CoreJavadocOptions
StandardJavadocDocletOptions

## Functions

bootClasspath
Link copied to clipboard
abstract fun bootClasspath(bootClasspath: Array<File>): MinimalJavadocOptions
breakIterator
Link copied to clipboard
abstract fun breakIterator(): MinimalJavadocOptions
abstract fun breakIterator(breakIterator: Boolean): MinimalJavadocOptions
classpath
Link copied to clipboard
abstract fun classpath(classpath: Array<File>): MinimalJavadocOptions
abstract fun classpath(classpath: List<File>): MinimalJavadocOptions
contributeCommandLineOptions
Link copied to clipboard
abstract fun contributeCommandLineOptions(execHandleBuilder: ExecSpec)
destinationDirectory
Link copied to clipboard
abstract fun destinationDirectory(directory: File): MinimalJavadocOptions
doclet
Link copied to clipboard
abstract fun doclet(docletClass: String): MinimalJavadocOptions
docletpath
Link copied to clipboard
abstract fun docletpath(docletpath: Array<File>): MinimalJavadocOptions
encoding
Link copied to clipboard
abstract fun encoding(encoding: String): MinimalJavadocOptions
extDirs
Link copied to clipboard
abstract fun extDirs(extDirs: Array<File>): MinimalJavadocOptions
getBootClasspath
Link copied to clipboard
@Classpath
abstract fun getBootClasspath(): List<File>
getClasspath
Link copied to clipboard
@Internal
abstract fun getClasspath(): List<File>
getDestinationDirectory
Link copied to clipboard
@Internal
abstract fun getDestinationDirectory(): File
getDoclet
Link copied to clipboard
@Nullable
@Optional
@Input
abstract fun getDoclet(): @Nullable String
getDocletpath
Link copied to clipboard
@Classpath
abstract fun getDocletpath(): List<File>
getEncoding
Link copied to clipboard
@Nullable
@Optional
@Input
abstract fun getEncoding(): @Nullable String
getExtDirs
Link copied to clipboard
@Nullable
@Optional
@IgnoreEmptyDirectories
@PathSensitive(value = PathSensitivity.RELATIVE)
@InputFiles
abstract fun getExtDirs(): @Nullable List<File>
getHeader
Link copied to clipboard
@Nullable
@Optional
@Input
abstract fun getHeader(): @Nullable String
getJFlags
Link copied to clipboard
@Nullable
@Optional
@Input
abstract fun getJFlags(): @Nullable List<String>
getLocale
Link copied to clipboard
@Nullable
@Optional
@Input
abstract fun getLocale(): @Nullable String
getMemberLevel
Link copied to clipboard
@Nullable
@Optional
@Input
abstract fun getMemberLevel(): @Nullable JavadocMemberLevel
getModulePath
Link copied to clipboard
@Internal
abstract fun getModulePath(): List<File>
The --module-path.
getOptionFiles
Link copied to clipboard
@Nullable
@Optional
@PathSensitive(value = PathSensitivity.NONE)
@InputFiles
abstract fun getOptionFiles(): @Nullable List<File>
getOutputLevel
Link copied to clipboard
@Console
abstract fun getOutputLevel(): JavadocOutputLevel
getOverview
Link copied to clipboard
@Nullable
@Optional
@Input
abstract fun getOverview(): @Nullable String
getSource
Link copied to clipboard
@Nullable
@Optional
@Input
abstract fun getSource(): @Nullable String
getSourceNames
Link copied to clipboard
@Nullable
@Internal
abstract fun getSourceNames(): @Nullable List<String>
getWindowTitle
Link copied to clipboard
@Nullable
@Optional
@Input
abstract fun getWindowTitle(): @Nullable String
header
Link copied to clipboard
abstract fun header(header: String): StandardJavadocDocletOptions
isBreakIterator
Link copied to clipboard
@Input
abstract fun isBreakIterator(): Boolean
isVerbose
Link copied to clipboard
@Internal
abstract fun isVerbose(): Boolean
jFlags
Link copied to clipboard
abstract fun jFlags(jFlags: Array<String>): MinimalJavadocOptions
locale
Link copied to clipboard
abstract fun locale(locale: String): MinimalJavadocOptions
modulePath
Link copied to clipboard
abstract fun modulePath(classpath: List<File>): MinimalJavadocOptions
The --module-path.
optionFiles
Link copied to clipboard
abstract fun optionFiles(argumentFiles: Array<File>): MinimalJavadocOptions
overview
Link copied to clipboard
abstract fun overview(overview: String): MinimalJavadocOptions
quiet
Link copied to clipboard
abstract fun quiet(): MinimalJavadocOptions
setBootClasspath
Link copied to clipboard
abstract fun setBootClasspath(bootClasspath: List<File>)
setBreakIterator
Link copied to clipboard
abstract fun setBreakIterator(breakIterator: Boolean)
setClasspath
Link copied to clipboard
abstract fun setClasspath(classpath: List<File>)
setDestinationDirectory
Link copied to clipboard
abstract fun setDestinationDirectory(@Nullable directory: @Nullable File)
setDoclet
Link copied to clipboard
abstract fun setDoclet(@Nullable docletClass: @Nullable String)
setDocletpath
Link copied to clipboard
abstract fun setDocletpath(docletpath: List<File>)
setEncoding
Link copied to clipboard
abstract fun setEncoding(@Nullable encoding: @Nullable String)
setExtDirs
Link copied to clipboard
abstract fun setExtDirs(@Nullable extDirs: @Nullable List<File>)
setHeader
Link copied to clipboard
abstract fun setHeader(@Nullable header: @Nullable String)
setJFlags
Link copied to clipboard
abstract fun setJFlags(@Nullable jFlags: @Nullable List<String>)
setLocale
Link copied to clipboard
abstract fun setLocale(@Nullable locale: @Nullable String)
setMemberLevel
Link copied to clipboard
abstract fun setMemberLevel(@Nullable memberLevel: @Nullable JavadocMemberLevel)
setModulePath
Link copied to clipboard
abstract fun setModulePath(modulePath: List<File>)
The --module-path.
setOptionFiles
Link copied to clipboard
abstract fun setOptionFiles(@Nullable optionFiles: @Nullable List<File>)
setOutputLevel
Link copied to clipboard
abstract fun setOutputLevel(outputLevel: JavadocOutputLevel)
setOverview
Link copied to clipboard
abstract fun setOverview(@Nullable overview: @Nullable String)
setSource
Link copied to clipboard
abstract fun setSource(@Nullable source: @Nullable String)
setSourceNames
Link copied to clipboard
abstract fun setSourceNames(@Nullable sourceNames: @Nullable List<String>)
setWindowTitle
Link copied to clipboard
abstract fun setWindowTitle(@Nullable windowTitle: @Nullable String)
showAll
Link copied to clipboard
abstract fun showAll(): MinimalJavadocOptions
showFromPackage
Link copied to clipboard
abstract fun showFromPackage(): MinimalJavadocOptions
showFromPrivate
Link copied to clipboard
abstract fun showFromPrivate(): MinimalJavadocOptions
showFromProtected
Link copied to clipboard
abstract fun showFromProtected(): MinimalJavadocOptions
showFromPublic
Link copied to clipboard
abstract fun showFromPublic(): MinimalJavadocOptions
source
Link copied to clipboard
abstract fun source(source: String): MinimalJavadocOptions
sourceNames
Link copied to clipboard
abstract fun sourceNames(sourceNames: Array<String>): MinimalJavadocOptions
verbose
Link copied to clipboard
abstract fun verbose(): MinimalJavadocOptions
windowTitle
Link copied to clipboard
abstract fun windowTitle(windowTitle: String): StandardJavadocDocletOptions
write
Link copied to clipboard
abstract fun write(outputFile: File)