CoreJavadocOptions

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

Inheritors

Constructors

Link copied to clipboard
constructor()

Properties

Link copied to clipboard
open var jFlags: List<String>
Link copied to clipboard
open var optionFiles: List<File>

Functions

Link copied to clipboard
Link copied to clipboard
open fun <T : Enum<T>?> addEnumOption(option: String, value: T): JavadocOptionFileOption<T>
Link copied to clipboard
Link copied to clipboard
Adds an option that will appear multiple times to the javadoc tool.
Link copied to clipboard
Adds an option that will appear multiple times to the javadoc tool.
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Adds an option that will have multiple values joined by the provided separator.
Link copied to clipboard
open fun bootClasspath(bootClasspath: Array<File>): MinimalJavadocOptions
Link copied to clipboard
Link copied to clipboard
open fun classpath(classpath: Array<File>): MinimalJavadocOptions
open fun classpath(classpath: List<File>): MinimalJavadocOptions
Link copied to clipboard
open fun contributeCommandLineOptions(execHandleBuilder: ExecSpec)
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open fun docletpath(docletpath: Array<File>): MinimalJavadocOptions
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
-bootclasspath classpathlist Specifies the paths where the boot classes reside.
Link copied to clipboard
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.
Link copied to clipboard
Link copied to clipboard
open fun getDoclet(): String
-doclet class Specifies the class file that starts the doclet used in generating the documentation.
Link copied to clipboard
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.
Link copied to clipboard
open fun getEncoding(): String
-encoding name Specifies the encoding name of the source files, such as EUCJIS/SJIS.
Link copied to clipboard
open fun getExtDirs(): List<File>
-extdirs dirlist Specifies the directories where extension classes reside.
Link copied to clipboard
abstract fun getHeader(): String
Link copied to clipboard
abstract fun getJFlags(): List<String>
Link copied to clipboard
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.
Link copied to clipboard
Switch to set the members that should be included in the Javadoc.
Link copied to clipboard
open fun getModulePath(): List<File>
Link copied to clipboard
abstract fun getOptionFiles(): List<File>
Link copied to clipboard
Control the Javadoc output level (-verbose or -quiet).
Link copied to clipboard
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).
Link copied to clipboard
open fun getSource(): String
-source release Specifies the version of source code accepted.
Link copied to clipboard
Link copied to clipboard
abstract fun getWindowTitle(): String
Link copied to clipboard
Link copied to clipboard
-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.
Link copied to clipboard
open fun isVerbose(): Boolean
Link copied to clipboard
Link copied to clipboard
Gets a set of all the options that are known to this class and have separate properties.
Link copied to clipboard
Link copied to clipboard
open fun modulePath(modulePath: List<File>): MinimalJavadocOptions
Link copied to clipboard
open fun optionFiles(argumentFiles: Array<File>): MinimalJavadocOptions
Link copied to clipboard
Fluent setter for the overview option.
Link copied to clipboard
Link copied to clipboard
open fun setBootClasspath(bootClasspath: List<File>)
Link copied to clipboard
open fun setBreakIterator(breakIterator: Boolean)
Link copied to clipboard
open fun setClasspath(classpath: List<File>)
Link copied to clipboard
abstract fun setDestinationDirectory(directory: File)
Link copied to clipboard
open fun setDoclet(doclet: String)
Link copied to clipboard
open fun setDocletpath(docletpath: List<File>)
Link copied to clipboard
open fun setEncoding(encoding: String)
Link copied to clipboard
open fun setExtDirs(extDirs: List<File>)
Link copied to clipboard
abstract fun setHeader(header: String)
Link copied to clipboard
abstract fun setJFlags(jFlags: List<String>)
Link copied to clipboard
open fun setLocale(locale: String)
Link copied to clipboard
open fun setMemberLevel(memberLevel: JavadocMemberLevel)
Link copied to clipboard
open fun setModulePath(modulePath: List<File>)
Link copied to clipboard
abstract fun setOptionFiles(optionFiles: List<File>)
Link copied to clipboard
open fun setOutputLevel(outputLevel: JavadocOutputLevel)
Link copied to clipboard
open fun setOverview(overview: String)
Link copied to clipboard
open fun setSource(source: String)
Link copied to clipboard
open fun setSourceNames(sourceNames: List<String>)
Link copied to clipboard
abstract fun setWindowTitle(windowTitle: String)
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
abstract fun windowTitle(windowTitle: String): StandardJavadocDocletOptions
Link copied to clipboard
fun write(outputFile: File)