# MinimalJavadocOptions

interface MinimalJavadocOptions(source)

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(): ConfigurableFileCollection
getBreakIterator
Link copied to clipboard
@Input
abstract fun getBreakIterator(): Property<Boolean>
getClasspath
Link copied to clipboard
@Internal
abstract fun getClasspath(): ConfigurableFileCollection
getDestinationDirectory
Link copied to clipboard
@Internal
abstract fun getDestinationDirectory(): DirectoryProperty
getDoclet
Link copied to clipboard
@Input
@Optional
abstract fun getDoclet(): Property<String>
getDocletpath
Link copied to clipboard
@Classpath
abstract fun getDocletpath(): ConfigurableFileCollection
getEncoding
Link copied to clipboard
@Input
@Optional
abstract fun getEncoding(): Property<String>
getExtDirs
Link copied to clipboard
@InputFiles
@Optional
@IgnoreEmptyDirectories
@PathSensitive(value = PathSensitivity.RELATIVE)
abstract fun getExtDirs(): ConfigurableFileCollection
getHeader
Link copied to clipboard
@Input
@Optional
abstract fun getHeader(): Property<String>
getIsBreakIterator
Link copied to clipboard
@Internal
abstract fun getIsBreakIterator(): Property<Boolean>
This method exists only for Kotlin source backward compatibility.
getIsVerbose
Link copied to clipboard
@Internal
abstract fun getIsVerbose(): Provider<Boolean>
This method exists only for Kotlin source backward compatibility.
getJFlags
Link copied to clipboard
@Input
@Optional
abstract fun getJFlags(): ListProperty<String>
getLocale
Link copied to clipboard
@Input
@Optional
abstract fun getLocale(): Property<String>
getMemberLevel
Link copied to clipboard
@Input
@Optional
abstract fun getMemberLevel(): Property<JavadocMemberLevel>
getModulePath
Link copied to clipboard
@Internal
abstract fun getModulePath(): ConfigurableFileCollection
The --module-path.
getOptionFiles
Link copied to clipboard
@InputFiles
@Optional
@PathSensitive(value = PathSensitivity.NONE)
abstract fun getOptionFiles(): ConfigurableFileCollection
getOutputLevel
Link copied to clipboard
@Console
abstract fun getOutputLevel(): Property<JavadocOutputLevel>
getOverview
Link copied to clipboard
@Input
@Optional
abstract fun getOverview(): Property<String>
getSource
Link copied to clipboard
@Input
@Optional
abstract fun getSource(): Property<String>
getSourceNames
Link copied to clipboard
@Internal
abstract fun getSourceNames(): ListProperty<String>
getVerbose
Link copied to clipboard
@Internal
abstract fun getVerbose(): Provider<Boolean>
getWindowTitle
Link copied to clipboard
@Input
@Optional
abstract fun getWindowTitle(): Property<String>
header
Link copied to clipboard
abstract fun header(header: String): StandardJavadocDocletOptions
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
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)