gradle/org.gradle.external.javadoc/CoreJavadocOptions

CoreJavadocOptions

abstract class CoreJavadocOptions : MinimalJavadocOptions(source)

Provides the core Javadoc Options. That is, provides the options which are not doclet specific.

Since

0.7

Inheritors

StandardJavadocDocletOptions

Constructors

CoreJavadocOptions

constructor()

Creates a new CoreJavadocOptions.

Properties

open var jFlags: List<String>

open var optionFiles: List<File>

Functions

addBooleanOption

open fun addBooleanOption(option: String): JavadocOptionFileOption<Boolean>

open fun addBooleanOption(option: String, value: Boolean): JavadocOptionFileOption<Boolean>

Adds an option that will be supplied or not without further arguments.

open fun <T : Enum<T>?> addEnumOption(option: String): JavadocOptionFileOption<T>

open fun <T : Enum<T>?> addEnumOption(option: String, value: T): JavadocOptionFileOption<T>

Adds an option that will use the lowercased toString() value of an enum constant as option.

open fun addFileOption(option: String): JavadocOptionFileOption<File>

open fun addFileOption(option: String, value: File): JavadocOptionFileOption<File>

Adds an option that will have an absolute file path supplied as a separate argument.

addMultilineMultiValueOption

open fun addMultilineMultiValueOption(option: String): JavadocOptionFileOption<List<List<String>>>

Adds an option that will appear multiple times each with zero, one, or multiple values supplied as individual argument each.

addMultilineStringsOption

open fun addMultilineStringsOption(option: String): JavadocOptionFileOption<List<String>>

Adds an option that will appear multiple times each with one value supplied as a separate argument.

open fun <T> addOption(option: JavadocOptionFileOption<T>): JavadocOptionFileOption<T>

Add option.

open fun addPathOption(option: String): JavadocOptionFileOption<List<File>>

Adds an option that will have multiple absolute file paths joined by path.separator supplied as a separate argument.

open fun addPathOption(option: String, joinBy: String): JavadocOptionFileOption<List<File>>

Adds an option that will have multiple absolute file paths joined by the provided separator supplied as a separate argument.

addStringOption

open fun addStringOption(option: String): JavadocOptionFileOption<String>

open fun addStringOption(option: String, value: String): JavadocOptionFileOption<String>

Adds an option that will have one string value supplied as a separate argument.

addStringsOption

open fun addStringsOption(option: String): JavadocOptionFileOption<List<String>>

Adds an option that will have multiple values joined by path.separator supplied as a separate argument.

open fun addStringsOption(option: String, joinBy: String): JavadocOptionFileOption<List<String>>

Adds an option that will have multiple values joined by the provided separator supplied as a separate argument.

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

Boot classpath.

open fun breakIterator(): MinimalJavadocOptions

open fun breakIterator(breakIterator: Boolean): MinimalJavadocOptions

Break iterator.

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

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

Classpath.

contributeCommandLineOptions

open fun contributeCommandLineOptions(execHandleBuilder: ExecSpec)

Contribute command line options.

destinationDirectory

abstract fun destinationDirectory(directory: File): MinimalJavadocOptions

Destination directory.

open fun doclet(doclet: String): MinimalJavadocOptions

Doclet.

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

Docletpath.

open fun encoding(encoding: String): MinimalJavadocOptions

Encoding.

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

Ext dirs.

getBootClasspath

open fun getBootClasspath(): List<File>

-bootclasspath classpathlist Specifies the paths where the boot classes reside.

open fun getClasspath(): List<File>

-classpath classpathlist Specifies the paths where javadoc will look for referenced classes (.class files) -- these are the documented classes plus any classes referenced by those classes.

getDestinationDirectory

abstract fun getDestinationDirectory(): File

Returns the destination directory.

open fun getDoclet(): String

-doclet class Specifies the class file that starts the doclet used in generating the documentation.

open fun getDocletpath(): List<File>

-docletpath classpathlist Specifies the path to the doclet starting class file (specified with the -doclet option) and any jar files it depends on.

open fun getEncoding(): String

-encoding name Specifies the encoding name of the source files, such as EUCJIS/SJIS.

open fun getExtDirs(): List<File>

-extdirs dirlist Specifies the directories where extension classes reside.

@Nullable

abstract fun getHeader(): @Nullable String

Returns the header.

open fun getLocale(): String

-locale language_country_variant Important - The -locale option must be placed ahead (to the left) of any options provided by the standard doclet or any other doclet.

open fun getMemberLevel(): JavadocMemberLevel

Switch to set the members that should be included in the Javadoc.

open fun getModulePath(): List<File>

The --module-path.

open fun getOutputLevel(): JavadocOutputLevel

Control the Javadoc output level (-verbose or -quiet).

open fun getOverview(): String

-overview path\filename Specifies that javadoc should retrieve the text for the overview documentation from the "source" file specified by path/filename and place it on the Overview page (overview-summary.html).

open fun getSource(): String

-source release Specifies the version of source code accepted.

open fun getSourceNames(): List<String>

Returns the source names.

@Nullable

abstract fun getWindowTitle(): @Nullable String

Returns the window title.

abstract fun header(header: String): StandardJavadocDocletOptions

Header.

isBreakIterator

open fun isBreakIterator(): Boolean

-breakiterator Uses the internationalized sentence boundary of java.text.BreakIterator to determine the end of the first sentence for English (all other locales already use BreakIterator), rather than an English language, locale-specific algorithm.

open fun isVerbose(): Boolean

Returns whether verbose is set.

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

J flags.

knownOptionNames

open fun knownOptionNames(): Set<String>

Gets a set of all the options that are known to this class and have separate properties.

open fun locale(locale: String): MinimalJavadocOptions

Locale.

open fun modulePath(modulePath: List<File>): MinimalJavadocOptions

The --module-path.

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

Option files.

open fun overview(overview: String): MinimalJavadocOptions

Fluent setter for the overview option.

open fun quiet(): MinimalJavadocOptions

Quiet.

setBootClasspath

open fun setBootClasspath(bootClasspath: List<File>)

Sets the boot classpath.

setBreakIterator

open fun setBreakIterator(breakIterator: Boolean)

Sets the break iterator.

open fun setClasspath(classpath: List<File>)

Sets the classpath.

setDestinationDirectory

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

Sets the destination directory.

open fun setDoclet(doclet: String)

Sets the doclet.

open fun setDocletpath(docletpath: List<File>)

Sets the docletpath.

open fun setEncoding(encoding: String)

Sets the encoding.

open fun setExtDirs(extDirs: 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.

open fun setLocale(locale: String)

Sets the locale.

open fun setMemberLevel(memberLevel: JavadocMemberLevel)

Sets the member level.

open fun setModulePath(modulePath: List<File>)

The --module-path.

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

Sets the option files.

open fun setOutputLevel(outputLevel: JavadocOutputLevel)

Sets the output level.

open fun setOverview(overview: String)

Sets the overview.

open fun setSource(source: String)

Sets the source.

open fun setSourceNames(sourceNames: List<String>)

Sets the source names.

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

Sets the window title.

open fun showAll(): MinimalJavadocOptions

Show all.

showFromPackage

open fun showFromPackage(): MinimalJavadocOptions

Show from package.

showFromPrivate

open fun showFromPrivate(): MinimalJavadocOptions

Show from private.

showFromProtected

open fun showFromProtected(): MinimalJavadocOptions

Show from protected.

open fun showFromPublic(): MinimalJavadocOptions

Show from public.

open fun source(source: String): MinimalJavadocOptions

Source.

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

Source names.

open fun verbose(): MinimalJavadocOptions

Verbose.

abstract fun windowTitle(windowTitle: String): StandardJavadocDocletOptions

Window title.

fun write(outputFile: File)

Write.