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.

Inheritors

StandardJavadocDocletOptions

Constructors

CoreJavadocOptions

constructor()

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>

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

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

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

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

addMultilineMultiValueOption

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

Adds an option that will appear multiple times to the javadoc tool.

addMultilineStringsOption

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

Adds an option that will appear multiple times to the javadoc tool.

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

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

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

addStringOption

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

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

addStringsOption

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

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

Adds an option that will have multiple values joined by the provided separator.

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

open fun breakIterator(): MinimalJavadocOptions

open fun breakIterator(breakIterator: Boolean): MinimalJavadocOptions

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

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

contributeCommandLineOptions

open fun contributeCommandLineOptions(execHandleBuilder: ExecSpec)

destinationDirectory

abstract fun destinationDirectory(directory: File): MinimalJavadocOptions

open fun doclet(doclet: String): MinimalJavadocOptions

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

open fun encoding(encoding: String): MinimalJavadocOptions

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

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

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.

abstract fun getHeader(): String

abstract fun getJFlags(): List<String>

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>

abstract fun getOptionFiles(): List<File>

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>

abstract fun getWindowTitle(): String

abstract fun header(header: String): StandardJavadocDocletOptions

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

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

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

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

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

open fun overview(overview: String): MinimalJavadocOptions

Fluent setter for the overview option.

open fun quiet(): MinimalJavadocOptions

setBootClasspath

open fun setBootClasspath(bootClasspath: List<File>)

setBreakIterator

open fun setBreakIterator(breakIterator: Boolean)

open fun setClasspath(classpath: List<File>)

setDestinationDirectory

abstract fun setDestinationDirectory(directory: File)

open fun setDoclet(doclet: String)

open fun setDocletpath(docletpath: List<File>)

open fun setEncoding(encoding: String)

open fun setExtDirs(extDirs: List<File>)

abstract fun setHeader(header: String)

abstract fun setJFlags(jFlags: List<String>)

open fun setLocale(locale: String)

open fun setMemberLevel(memberLevel: JavadocMemberLevel)

open fun setModulePath(modulePath: List<File>)

abstract fun setOptionFiles(optionFiles: List<File>)

open fun setOutputLevel(outputLevel: JavadocOutputLevel)

open fun setOverview(overview: String)

open fun setSource(source: String)

open fun setSourceNames(sourceNames: List<String>)

abstract fun setWindowTitle(windowTitle: String)

open fun showAll(): MinimalJavadocOptions

showFromPackage

open fun showFromPackage(): MinimalJavadocOptions

showFromPrivate

open fun showFromPrivate(): MinimalJavadocOptions

showFromProtected

open fun showFromProtected(): MinimalJavadocOptions

open fun showFromPublic(): MinimalJavadocOptions

open fun source(source: String): MinimalJavadocOptions

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

open fun verbose(): MinimalJavadocOptions

abstract fun windowTitle(windowTitle: String): StandardJavadocDocletOptions

fun write(outputFile: File)