gradle/org.gradle.external.javadoc/MinimalJavadocOptions

MinimalJavadocOptions

interface MinimalJavadocOptions(source)

Provides the core Javadoc options.

Inheritors

StandardJavadocDocletOptions

CoreJavadocOptions

Functions

bootClasspath

abstract fun bootClasspath(bootClasspath: Array<File>): MinimalJavadocOptions

breakIterator

abstract fun breakIterator(): MinimalJavadocOptions

abstract fun breakIterator(breakIterator: Boolean): MinimalJavadocOptions

classpath

abstract fun classpath(classpath: Array<File>): MinimalJavadocOptions

abstract fun classpath(classpath: List<File>): MinimalJavadocOptions

contributeCommandLineOptions

abstract fun contributeCommandLineOptions(execHandleBuilder: ExecSpec)

destinationDirectory

abstract fun destinationDirectory(directory: File): MinimalJavadocOptions

doclet

abstract fun doclet(docletClass: String): MinimalJavadocOptions

docletpath

abstract fun docletpath(docletpath: Array<File>): MinimalJavadocOptions

encoding

abstract fun encoding(encoding: String): MinimalJavadocOptions

extDirs

abstract fun extDirs(extDirs: Array<File>): MinimalJavadocOptions

getBootClasspath

@Classpath

abstract fun getBootClasspath(): ConfigurableFileCollection

getBreakIterator

@Input

abstract fun getBreakIterator(): Property<Boolean>

getClasspath

@Internal

abstract fun getClasspath(): ConfigurableFileCollection

getDestinationDirectory

@Internal

abstract fun getDestinationDirectory(): DirectoryProperty

getDoclet

@Input

@Optional

abstract fun getDoclet(): Property<String>

getDocletpath

@Classpath

abstract fun getDocletpath(): ConfigurableFileCollection

getEncoding

@Input

@Optional

abstract fun getEncoding(): Property<String>

getExtDirs

@InputFiles

@Optional

@IgnoreEmptyDirectories

@PathSensitive(value = PathSensitivity.RELATIVE)

abstract fun getExtDirs(): ConfigurableFileCollection

getHeader

@Input

@Optional

abstract fun getHeader(): Property<String>

getIsBreakIterator

@Internal

abstract fun getIsBreakIterator(): Property<Boolean>

This method exists only for Kotlin source backward compatibility.

getIsVerbose

@Internal

abstract fun getIsVerbose(): Provider<Boolean>

This method exists only for Kotlin source backward compatibility.

getJFlags

@Input

@Optional

abstract fun getJFlags(): ListProperty<String>

getLocale

@Input

@Optional

abstract fun getLocale(): Property<String>

getMemberLevel

@Input

@Optional

abstract fun getMemberLevel(): Property<JavadocMemberLevel>

getModulePath

@Internal

abstract fun getModulePath(): ConfigurableFileCollection

The --module-path.

getOptionFiles

@InputFiles

@Optional

@PathSensitive(value = PathSensitivity.NONE)

abstract fun getOptionFiles(): ConfigurableFileCollection

getOutputLevel

@Console

abstract fun getOutputLevel(): Property<JavadocOutputLevel>

getOverview

@Input

@Optional

abstract fun getOverview(): Property<String>

getSource

@Input

@Optional

abstract fun getSource(): Property<String>

getSourceNames

@Internal

abstract fun getSourceNames(): ListProperty<String>

getVerbose

@Internal

abstract fun getVerbose(): Provider<Boolean>

getWindowTitle

@Input

@Optional

abstract fun getWindowTitle(): Property<String>

header

abstract fun header(header: String): StandardJavadocDocletOptions

jFlags

abstract fun jFlags(jFlags: Array<String>): MinimalJavadocOptions

locale

abstract fun locale(locale: String): MinimalJavadocOptions

modulePath

abstract fun modulePath(classpath: List<File>): MinimalJavadocOptions

The --module-path.

optionFiles

abstract fun optionFiles(argumentFiles: Array<File>): MinimalJavadocOptions

overview

abstract fun overview(overview: String): MinimalJavadocOptions

quiet

abstract fun quiet(): MinimalJavadocOptions

setBootClasspath

abstract fun setBootClasspath(bootClasspath: List<File>)

setBreakIterator

abstract fun setBreakIterator(breakIterator: Boolean)

setClasspath

abstract fun setClasspath(classpath: List<File>)

setDestinationDirectory

abstract fun setDestinationDirectory(@Nullable destinationDirectory: @Nullable File)

setDoclet

abstract fun setDoclet(@Nullable docletClass: @Nullable String)

setDocletpath

abstract fun setDocletpath(docletpath: List<File>)

setEncoding

abstract fun setEncoding(@Nullable encoding: @Nullable String)

setExtDirs

abstract fun setExtDirs(@Nullable extDirs: @Nullable List<File>)

setHeader

abstract fun setHeader(@Nullable header: @Nullable String)

setJFlags

abstract fun setJFlags(@Nullable jFlags: @Nullable List<String>)

setLocale

abstract fun setLocale(@Nullable locale: @Nullable String)

setMemberLevel

abstract fun setMemberLevel(@Nullable memberLevel: @Nullable JavadocMemberLevel)

setModulePath

abstract fun setModulePath(modulePath: List<File>)

The --module-path.

setOptionFiles

abstract fun setOptionFiles(@Nullable optionFiles: @Nullable List<File>)

setOutputLevel

abstract fun setOutputLevel(outputLevel: JavadocOutputLevel)

setOverview

abstract fun setOverview(@Nullable overview: @Nullable String)

setSource

abstract fun setSource(@Nullable source: @Nullable String)

setSourceNames

abstract fun setSourceNames(@Nullable sourceNames: @Nullable List<String>)

setWindowTitle

abstract fun setWindowTitle(@Nullable windowTitle: @Nullable String)

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(sourceNames: Array<String>): MinimalJavadocOptions

verbose

abstract fun verbose(): MinimalJavadocOptions

windowTitle

abstract fun windowTitle(windowTitle: String): StandardJavadocDocletOptions

write

abstract fun write(outputFile: File)