# MinimalJavadocOptions

interface MinimalJavadocOptions(source)

Provides the core Javadoc options.

#### Since

0.7

#### Inheritors

CoreJavadocOptions
StandardJavadocDocletOptions

## Functions

bootClasspath
Link copied to clipboard
abstract fun bootClasspath(bootClasspath: Array<File>): MinimalJavadocOptions
Boot classpath.
breakIterator
Link copied to clipboard
abstract fun breakIterator(): MinimalJavadocOptions
abstract fun breakIterator(breakIterator: Boolean): MinimalJavadocOptions
Break iterator.
classpath
Link copied to clipboard
abstract fun classpath(classpath: Array<File>): MinimalJavadocOptions
abstract fun classpath(classpath: List<File>): MinimalJavadocOptions
Classpath.
contributeCommandLineOptions
Link copied to clipboard
abstract fun contributeCommandLineOptions(execHandleBuilder: ExecSpec)
Contribute command line options.
destinationDirectory
Link copied to clipboard
abstract fun destinationDirectory(directory: File): MinimalJavadocOptions
Destination directory.
doclet
Link copied to clipboard
abstract fun doclet(docletClass: String): MinimalJavadocOptions
Doclet.
docletpath
Link copied to clipboard
abstract fun docletpath(docletpath: Array<File>): MinimalJavadocOptions
Docletpath.
encoding
Link copied to clipboard
abstract fun encoding(encoding: String): MinimalJavadocOptions
Encoding.
extDirs
Link copied to clipboard
abstract fun extDirs(extDirs: Array<File>): MinimalJavadocOptions
Ext dirs.
getBootClasspath
Link copied to clipboard
@Classpath
abstract fun getBootClasspath(): List<File>
Returns the boot classpath.
getClasspath
Link copied to clipboard
@Internal
abstract fun getClasspath(): List<File>
Returns the classpath.
getDestinationDirectory
Link copied to clipboard
@Internal
abstract fun getDestinationDirectory(): File
Returns the destination directory.
getDoclet
Link copied to clipboard
@Nullable
@Optional
@Input
abstract fun getDoclet(): @Nullable String
Returns the doclet.
getDocletpath
Link copied to clipboard
@Classpath
abstract fun getDocletpath(): List<File>
Returns the docletpath.
getEncoding
Link copied to clipboard
@Nullable
@Optional
@Input
abstract fun getEncoding(): @Nullable String
Returns the encoding.
getExtDirs
Link copied to clipboard
@Nullable
@Optional
@IgnoreEmptyDirectories
@PathSensitive(value = PathSensitivity.RELATIVE)
@InputFiles
abstract fun getExtDirs(): @Nullable List<File>
Returns the ext dirs.
getHeader
Link copied to clipboard
@Nullable
@Optional
@Input
abstract fun getHeader(): @Nullable String
Returns the header.
getJFlags
Link copied to clipboard
@Nullable
@Optional
@Input
abstract fun getJFlags(): @Nullable List<String>
Returns the j flags.
getLocale
Link copied to clipboard
@Nullable
@Optional
@Input
abstract fun getLocale(): @Nullable String
Returns the locale.
getMemberLevel
Link copied to clipboard
@Nullable
@Optional
@Input
abstract fun getMemberLevel(): @Nullable JavadocMemberLevel
Returns the member level.
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>
Returns the option files.
getOutputLevel
Link copied to clipboard
@Console
abstract fun getOutputLevel(): JavadocOutputLevel
Returns the output level.
getOverview
Link copied to clipboard
@Nullable
@Optional
@Input
abstract fun getOverview(): @Nullable String
Returns the overview.
getSource
Link copied to clipboard
@Nullable
@Optional
@Input
abstract fun getSource(): @Nullable String
Returns the source.
getSourceNames
Link copied to clipboard
@Nullable
@Internal
abstract fun getSourceNames(): @Nullable List<String>
Returns the source names.
getWindowTitle
Link copied to clipboard
@Nullable
@Optional
@Input
abstract fun getWindowTitle(): @Nullable String
Returns the window title.
header
Link copied to clipboard
abstract fun header(header: String): StandardJavadocDocletOptions
Header.
isBreakIterator
Link copied to clipboard
@Input
abstract fun isBreakIterator(): Boolean
Returns whether break iterator is set.
isVerbose
Link copied to clipboard
@Internal
abstract fun isVerbose(): Boolean
Returns whether verbose is set.
jFlags
Link copied to clipboard
abstract fun jFlags(jFlags: Array<String>): MinimalJavadocOptions
J flags.
locale
Link copied to clipboard
abstract fun locale(locale: String): MinimalJavadocOptions
Locale.
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
Option files.
overview
Link copied to clipboard
abstract fun overview(overview: String): MinimalJavadocOptions
Overview.
quiet
Link copied to clipboard
abstract fun quiet(): MinimalJavadocOptions
Quiet.
setBootClasspath
Link copied to clipboard
abstract fun setBootClasspath(bootClasspath: List<File>)
Sets the boot classpath.
setBreakIterator
Link copied to clipboard
abstract fun setBreakIterator(breakIterator: Boolean)
Sets the break iterator.
setClasspath
Link copied to clipboard
abstract fun setClasspath(classpath: List<File>)
Sets the classpath.
setDestinationDirectory
Link copied to clipboard
abstract fun setDestinationDirectory(@Nullable directory: @Nullable File)
Sets the destination directory.
setDoclet
Link copied to clipboard
abstract fun setDoclet(@Nullable docletClass: @Nullable String)
Sets the doclet.
setDocletpath
Link copied to clipboard
abstract fun setDocletpath(docletpath: List<File>)
Sets the docletpath.
setEncoding
Link copied to clipboard
abstract fun setEncoding(@Nullable encoding: @Nullable String)
Sets the encoding.
setExtDirs
Link copied to clipboard
abstract fun setExtDirs(@Nullable extDirs: @Nullable List<File>)
Sets the ext dirs.
setHeader
Link copied to clipboard
abstract fun setHeader(@Nullable header: @Nullable String)
Sets the header.
setJFlags
Link copied to clipboard
abstract fun setJFlags(@Nullable jFlags: @Nullable List<String>)
Sets the j flags.
setLocale
Link copied to clipboard
abstract fun setLocale(@Nullable locale: @Nullable String)
Sets the locale.
setMemberLevel
Link copied to clipboard
abstract fun setMemberLevel(@Nullable memberLevel: @Nullable JavadocMemberLevel)
Sets the member level.
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>)
Sets the option files.
setOutputLevel
Link copied to clipboard
abstract fun setOutputLevel(outputLevel: JavadocOutputLevel)
Sets the output level.
setOverview
Link copied to clipboard
abstract fun setOverview(@Nullable overview: @Nullable String)
Sets the overview.
setSource
Link copied to clipboard
abstract fun setSource(@Nullable source: @Nullable String)
Sets the source.
setSourceNames
Link copied to clipboard
abstract fun setSourceNames(@Nullable sourceNames: @Nullable List<String>)
Sets the source names.
setWindowTitle
Link copied to clipboard
abstract fun setWindowTitle(@Nullable windowTitle: @Nullable String)
Sets the window title.
showAll
Link copied to clipboard
abstract fun showAll(): MinimalJavadocOptions
Show all.
showFromPackage
Link copied to clipboard
abstract fun showFromPackage(): MinimalJavadocOptions
Show from package.
showFromPrivate
Link copied to clipboard
abstract fun showFromPrivate(): MinimalJavadocOptions
Show from private.
showFromProtected
Link copied to clipboard
abstract fun showFromProtected(): MinimalJavadocOptions
Show from protected.
showFromPublic
Link copied to clipboard
abstract fun showFromPublic(): MinimalJavadocOptions
Show from public.
source
Link copied to clipboard
abstract fun source(source: String): MinimalJavadocOptions
Source.
sourceNames
Link copied to clipboard
abstract fun sourceNames(sourceNames: Array<String>): MinimalJavadocOptions
Source names.
verbose
Link copied to clipboard
abstract fun verbose(): MinimalJavadocOptions
Verbose.
windowTitle
Link copied to clipboard
abstract fun windowTitle(windowTitle: String): StandardJavadocDocletOptions
Window title.
write
Link copied to clipboard
abstract fun write(outputFile: File)
Write.