gradle/org.gradle.external.javadoc/MinimalJavadocOptions

MinimalJavadocOptions

interface MinimalJavadocOptions(source)

Provides the core Javadoc options.

Since

0.7

Inheritors

StandardJavadocDocletOptions

CoreJavadocOptions

Functions

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

Boot classpath.

abstract fun breakIterator(): MinimalJavadocOptions

abstract fun breakIterator(breakIterator: Boolean): MinimalJavadocOptions

Break iterator.

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

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

Classpath.

contributeCommandLineOptions

abstract fun contributeCommandLineOptions(execHandleBuilder: ExecSpec)

Contribute command line options.

destinationDirectory

abstract fun destinationDirectory(directory: File): MinimalJavadocOptions

Destination directory.

abstract fun doclet(docletClass: String): MinimalJavadocOptions

Doclet.

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

Docletpath.

abstract fun encoding(encoding: String): MinimalJavadocOptions

Encoding.

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

Ext dirs.

getBootClasspath

abstract fun getBootClasspath(): List<File>

Returns the boot classpath.

abstract fun getClasspath(): List<File>

Returns the classpath.

getDestinationDirectory

abstract fun getDestinationDirectory(): File

Returns the destination directory.

@Nullable

abstract fun getDoclet(): @Nullable String

Returns the doclet.

abstract fun getDocletpath(): List<File>

Returns the docletpath.

@Nullable

abstract fun getEncoding(): @Nullable String

Returns the encoding.

@Nullable

@IgnoreEmptyDirectories

@PathSensitive(value = PathSensitivity.RELATIVE)

abstract fun getExtDirs(): @Nullable List<File>

Returns the ext dirs.

@Nullable

abstract fun getHeader(): @Nullable String

Returns the header.

@Nullable

abstract fun getJFlags(): @Nullable List<String>

Returns the j flags.

@Nullable

abstract fun getLocale(): @Nullable String

Returns the locale.

@Nullable

abstract fun getMemberLevel(): @Nullable JavadocMemberLevel

Returns the member level.

abstract fun getModulePath(): List<File>

The --module-path.

@Nullable

@PathSensitive(value = PathSensitivity.NONE)

abstract fun getOptionFiles(): @Nullable List<File>

Returns the option files.

abstract fun getOutputLevel(): JavadocOutputLevel

Returns the output level.

@Nullable

abstract fun getOverview(): @Nullable String

Returns the overview.

@Nullable

abstract fun getSource(): @Nullable String

Returns the source.

@Nullable

abstract fun getSourceNames(): @Nullable List<String>

Returns the source names.

@Nullable

abstract fun getWindowTitle(): @Nullable String

Returns the window title.

abstract fun header(header: String): StandardJavadocDocletOptions

Header.

isBreakIterator

abstract fun isBreakIterator(): Boolean

Returns whether break iterator is set.

abstract fun isVerbose(): Boolean

Returns whether verbose is set.

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

J flags.

abstract fun locale(locale: String): MinimalJavadocOptions

Locale.

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

The --module-path.

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

Option files.

abstract fun overview(overview: String): MinimalJavadocOptions

Overview.

abstract fun quiet(): MinimalJavadocOptions

Quiet.

setBootClasspath

abstract fun setBootClasspath(bootClasspath: List<File>)

Sets the boot classpath.

setBreakIterator

abstract fun setBreakIterator(breakIterator: Boolean)

Sets the break iterator.

abstract fun setClasspath(classpath: List<File>)

Sets the classpath.

setDestinationDirectory

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

Sets the destination directory.

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

Sets the doclet.

abstract fun setDocletpath(docletpath: List<File>)

Sets the docletpath.

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

Sets the encoding.

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

Sets the ext dirs.

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

Sets the header.

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

Sets the j flags.

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

Sets the locale.

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

Sets the member level.

abstract fun setModulePath(modulePath: List<File>)

The --module-path.

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

Sets the option files.

abstract fun setOutputLevel(outputLevel: JavadocOutputLevel)

Sets the output level.

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

Sets the overview.

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

Sets the source.

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

Sets the source names.

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

Sets the window title.

abstract fun showAll(): MinimalJavadocOptions

Show all.

showFromPackage

abstract fun showFromPackage(): MinimalJavadocOptions

Show from package.

showFromPrivate

abstract fun showFromPrivate(): MinimalJavadocOptions

Show from private.

showFromProtected

abstract fun showFromProtected(): MinimalJavadocOptions

Show from protected.

abstract fun showFromPublic(): MinimalJavadocOptions

Show from public.

abstract fun source(source: String): MinimalJavadocOptions

Source.

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

Source names.

abstract fun verbose(): MinimalJavadocOptions

Verbose.

abstract fun windowTitle(windowTitle: String): StandardJavadocDocletOptions

Window title.

abstract fun write(outputFile: File)

Write.