MinimalJavadocOptions
StandardJavadocDocletOptions
public abstract class CoreJavadocOptions extends java.lang.Object implements MinimalJavadocOptions
Modifier and Type | Field | Description |
---|---|---|
protected java.util.Set<java.lang.String> |
knownCoreOptionNames |
Core options which are known, and have corresponding fields in this class.
|
protected org.gradle.external.javadoc.internal.JavadocOptionFile |
optionFile |
Modifier | Constructor | Description |
---|---|---|
|
CoreJavadocOptions() |
|
protected |
CoreJavadocOptions(CoreJavadocOptions original,
org.gradle.external.javadoc.internal.JavadocOptionFile optionFile) |
|
protected |
CoreJavadocOptions(org.gradle.external.javadoc.internal.JavadocOptionFile optionFile) |
Modifier and Type | Method | Description |
---|---|---|
JavadocOptionFileOption<java.lang.Boolean> |
addBooleanOption(java.lang.String option) |
|
JavadocOptionFileOption<java.lang.Boolean> |
addBooleanOption(java.lang.String option,
boolean value) |
|
<T extends java.lang.Enum<T>> |
addEnumOption(java.lang.String option) |
|
<T extends java.lang.Enum<T>> |
addEnumOption(java.lang.String option,
T value) |
|
JavadocOptionFileOption<java.io.File> |
addFileOption(java.lang.String option) |
|
JavadocOptionFileOption<java.io.File> |
addFileOption(java.lang.String option,
java.io.File value) |
|
JavadocOptionFileOption<java.util.List<java.util.List<java.lang.String>>> |
addMultilineMultiValueOption(java.lang.String option) |
Adds an option that will appear multiple times to the javadoc tool.
|
JavadocOptionFileOption<java.util.List<java.lang.String>> |
addMultilineStringsOption(java.lang.String option) |
Adds an option that will appear multiple times to the javadoc tool.
|
<T> JavadocOptionFileOption<T> |
addOption(JavadocOptionFileOption<T> option) |
|
JavadocOptionFileOption<java.util.List<java.io.File>> |
addPathOption(java.lang.String option) |
|
JavadocOptionFileOption<java.util.List<java.io.File>> |
addPathOption(java.lang.String option,
java.lang.String joinBy) |
|
JavadocOptionFileOption<java.lang.String> |
addStringOption(java.lang.String option) |
|
JavadocOptionFileOption<java.lang.String> |
addStringOption(java.lang.String option,
java.lang.String value) |
|
JavadocOptionFileOption<java.util.List<java.lang.String>> |
addStringsOption(java.lang.String option) |
|
JavadocOptionFileOption<java.util.List<java.lang.String>> |
addStringsOption(java.lang.String option,
java.lang.String joinBy) |
Adds an option that will have multiple values joined by the provided separator.
|
MinimalJavadocOptions |
bootClasspath(java.io.File... bootClasspath) |
|
MinimalJavadocOptions |
breakIterator() |
|
MinimalJavadocOptions |
breakIterator(boolean breakIterator) |
|
MinimalJavadocOptions |
classpath(java.io.File... classpath) |
|
MinimalJavadocOptions |
classpath(java.util.List<java.io.File> classpath) |
|
void |
contributeCommandLineOptions(ExecSpec execHandleBuilder) |
|
MinimalJavadocOptions |
doclet(java.lang.String doclet) |
|
MinimalJavadocOptions |
docletpath(java.io.File... docletpath) |
|
MinimalJavadocOptions |
encoding(java.lang.String encoding) |
|
MinimalJavadocOptions |
extDirs(java.io.File... extDirs) |
|
java.util.List<java.io.File> |
getBootClasspath() |
-bootclasspath classpathlist
Specifies the paths where the boot classes reside.
|
java.util.List<java.io.File> |
getClasspath() |
-classpath classpathlist
|
java.lang.String |
getDoclet() |
-doclet class
|
java.util.List<java.io.File> |
getDocletpath() |
-docletpath classpathlist
|
java.lang.String |
getEncoding() |
-encoding name
|
java.util.List<java.io.File> |
getExtDirs() |
-extdirs dirlist
|
protected java.lang.String |
getExtraOptions() |
This method exists so that changing any options to the Javadoc task causes it to be re-run.
|
java.util.List<java.lang.String> |
getJFlags() |
-Jflag
|
java.lang.String |
getLocale() |
-locale language_country_variant
|
JavadocMemberLevel |
getMemberLevel() |
Switch to set the members that should be included in the Javadoc.
|
java.util.List<java.io.File> |
getModulePath() |
The --module-path.
|
java.util.List<java.io.File> |
getOptionFiles() |
|
JavadocOutputLevel |
getOutputLevel() |
Control the Javadoc output level (-verbose or -quiet).
|
java.lang.String |
getOverview() |
-overview path\filename
|
java.lang.String |
getSource() |
-source release
|
java.util.List<java.lang.String> |
getSourceNames() |
|
boolean |
isBreakIterator() |
-breakiterator
|
boolean |
isVerbose() |
|
MinimalJavadocOptions |
jFlags(java.lang.String... jFlags) |
|
java.util.Set<java.lang.String> |
knownOptionNames() |
Gets a set of all the options that are known to this class and have separate properties.
|
MinimalJavadocOptions |
locale(java.lang.String locale) |
|
MinimalJavadocOptions |
modulePath(java.util.List<java.io.File> modulePath) |
The --module-path.
|
MinimalJavadocOptions |
optionFiles(java.io.File... argumentFiles) |
|
MinimalJavadocOptions |
overview(java.lang.String overview) |
Fluent setter for the overview option.
|
MinimalJavadocOptions |
quiet() |
|
void |
setBootClasspath(java.util.List<java.io.File> bootClasspath) |
|
void |
setBreakIterator(boolean breakIterator) |
|
void |
setClasspath(java.util.List<java.io.File> classpath) |
|
void |
setDoclet(java.lang.String doclet) |
|
void |
setDocletpath(java.util.List<java.io.File> docletpath) |
|
void |
setEncoding(java.lang.String encoding) |
|
void |
setExtDirs(java.util.List<java.io.File> extDirs) |
|
void |
setJFlags(java.util.List<java.lang.String> jFlags) |
|
void |
setLocale(java.lang.String locale) |
|
void |
setMemberLevel(JavadocMemberLevel memberLevel) |
|
void |
setModulePath(java.util.List<java.io.File> modulePath) |
The --module-path.
|
void |
setOptionFiles(java.util.List<java.io.File> optionFiles) |
|
void |
setOutputLevel(JavadocOutputLevel outputLevel) |
|
void |
setOverview(java.lang.String overview) |
|
void |
setSource(java.lang.String source) |
|
void |
setSourceNames(java.util.List<java.lang.String> sourceNames) |
|
MinimalJavadocOptions |
showAll() |
|
MinimalJavadocOptions |
showFromPackage() |
|
MinimalJavadocOptions |
showFromPrivate() |
|
MinimalJavadocOptions |
showFromProtected() |
|
MinimalJavadocOptions |
showFromPublic() |
|
MinimalJavadocOptions |
source(java.lang.String source) |
|
MinimalJavadocOptions |
sourceNames(java.lang.String... sourceNames) |
|
MinimalJavadocOptions |
verbose() |
|
void |
write(java.io.File outputFile) |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
destinationDirectory, getDestinationDirectory, getHeader, getWindowTitle, header, setDestinationDirectory, setHeader, setWindowTitle, windowTitle
protected final org.gradle.external.javadoc.internal.JavadocOptionFile optionFile
@Incubating protected final java.util.Set<java.lang.String> knownCoreOptionNames
public CoreJavadocOptions()
protected CoreJavadocOptions(org.gradle.external.javadoc.internal.JavadocOptionFile optionFile)
protected CoreJavadocOptions(CoreJavadocOptions original, org.gradle.external.javadoc.internal.JavadocOptionFile optionFile)
@Incubating public java.util.Set<java.lang.String> knownOptionNames()
public java.lang.String getOverview()
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). The path/filename is relative to the -sourcepath.
While you can use any name you want for filename and place it anywhere you want for path, a typical thing to do is to name it overview.html and place it in the source tree at the directory that contains the topmost package directories. In this location, no path is needed when documenting packages, since -sourcepath will point to this file. For example, if the source tree for the java.lang package is C:\src\classes\java\lang\, then you could place the overview file at C:\src\classes\overview.html. See Real World Example.
For information about the file specified by path/filename, see overview comment file.
Note that the overview page is created only if you pass into javadoc two or more package names. For further explanation, see HTML Frames.)
The title on the overview page is set by -doctitle.
getOverview
in interface MinimalJavadocOptions
public void setOverview(java.lang.String overview)
setOverview
in interface MinimalJavadocOptions
public MinimalJavadocOptions overview(java.lang.String overview)
overview
in interface MinimalJavadocOptions
overview
- The new overview.MinimalJavadocOptions
object.public JavadocMemberLevel getMemberLevel()
getMemberLevel
in interface MinimalJavadocOptions
public void setMemberLevel(JavadocMemberLevel memberLevel)
setMemberLevel
in interface MinimalJavadocOptions
public MinimalJavadocOptions showFromPublic()
showFromPublic
in interface MinimalJavadocOptions
public MinimalJavadocOptions showFromProtected()
showFromProtected
in interface MinimalJavadocOptions
public MinimalJavadocOptions showFromPackage()
showFromPackage
in interface MinimalJavadocOptions
public MinimalJavadocOptions showFromPrivate()
showFromPrivate
in interface MinimalJavadocOptions
public MinimalJavadocOptions showAll()
showAll
in interface MinimalJavadocOptions
public java.lang.String getDoclet()
Specifies the class file that starts the doclet used in generating the documentation. Use the fully-qualified name. This doclet defines the content and formats the output. If the -doclet option is not used, javadoc uses the standard doclet for generating the default HTML format. This class must contain the start(Root) method. The path to this starting class is defined by the -docletpath option.
For example, to call the MIF doclet, use:
-doclet com.sun.tools.doclets.mif.MIFDoclet
For full, working examples of running a particular doclet, see Running the MIF Doclet.
getDoclet
in interface MinimalJavadocOptions
public void setDoclet(java.lang.String doclet)
setDoclet
in interface MinimalJavadocOptions
public MinimalJavadocOptions doclet(java.lang.String doclet)
doclet
in interface MinimalJavadocOptions
public java.util.List<java.io.File> getDocletpath()
Specifies the path to the doclet starting class file (specified with the -doclet option) and any jar files it depends on. If the starting class file is in a jar file, then this specifies the path to that jar file, as shown in the example below. You can specify an absolute path or a path relative to the current directory. If classpathlist contains multiple paths or jar files, they should be separated with a colon (:) on Solaris and a semi-colon (;) on Windows. This option is not necessary if the doclet starting class is already in the search path.
Example of path to jar file that contains the starting doclet class file. Notice the jar filename is included.
-docletpath C:/user/mifdoclet/lib/mifdoclet.jar
Example of path to starting doclet class file. Notice the class filename is omitted.
-docletpath C:/user/mifdoclet/classes/com/sun/tools/doclets/mif/
For full, working examples of running a particular doclet, see Running the MIF Doclet.
getDocletpath
in interface MinimalJavadocOptions
public void setDocletpath(java.util.List<java.io.File> docletpath)
setDocletpath
in interface MinimalJavadocOptions
public MinimalJavadocOptions docletpath(java.io.File... docletpath)
docletpath
in interface MinimalJavadocOptions
public java.lang.String getSource()
Specifies the version of source code accepted. The following values for release are allowed:
1.5 javadoc accepts code containing generics and other language features introduced in JDK 1.5.
The compiler defaults to the 1.5 behavior if the -source flag is not used.
1.4 javadoc accepts code containing assertions, which were introduced in JDK 1.4.
1.3 javadoc does not support assertions, generics, or other language features introduced after JDK 1.3.
Use the value of release corresponding to that used when compiling the code with javac.
getSource
in interface MinimalJavadocOptions
public void setSource(java.lang.String source)
setSource
in interface MinimalJavadocOptions
public MinimalJavadocOptions source(java.lang.String source)
source
in interface MinimalJavadocOptions
public java.util.List<java.io.File> getClasspath()
Specifies the paths where javadoc will look for referenced classes (.class files) -- these are the documented classes plus any classes referenced by those classes. The classpathlist can contain multiple paths by separating them with a semicolon (;). The Javadoc tool will search in all subdirectories of the specified paths. Follow the instructions in class path documentation for specifying classpathlist.
If -sourcepath is omitted, the Javadoc tool uses -classpath to find the source files as well as class files (for backward compatibility). Therefore, if you want to search for source and class files in separate paths, use both -sourcepath and -classpath.
For example, if you want to document com.mypackage, whose source files reside in the directory C:/user/src/com/mypackage, and if this package relies on a library in C:/user/lib, you would specify:
javadoc -classpath /user/lib -sourcepath /user/src com.mypackage
As with other tools, if you do not specify -classpath, the Javadoc tool uses the CLASSPATH environment variable, if it is set. If both are not set, the Javadoc tool searches for classes from the current directory.
For an in-depth description of how the Javadoc tool uses -classpath to find user classes as it relates to extension classes and bootstrap classes, see How Classes Are Found.
getClasspath
in interface MinimalJavadocOptions
public void setClasspath(java.util.List<java.io.File> classpath)
setClasspath
in interface MinimalJavadocOptions
public java.util.List<java.io.File> getModulePath()
MinimalJavadocOptions
getModulePath
in interface MinimalJavadocOptions
public void setModulePath(java.util.List<java.io.File> modulePath)
MinimalJavadocOptions
setModulePath
in interface MinimalJavadocOptions
public MinimalJavadocOptions modulePath(java.util.List<java.io.File> modulePath)
MinimalJavadocOptions
modulePath
in interface MinimalJavadocOptions
public MinimalJavadocOptions classpath(java.util.List<java.io.File> classpath)
classpath
in interface MinimalJavadocOptions
public MinimalJavadocOptions classpath(java.io.File... classpath)
classpath
in interface MinimalJavadocOptions
public java.util.List<java.io.File> getBootClasspath()
getBootClasspath
in interface MinimalJavadocOptions
public void setBootClasspath(java.util.List<java.io.File> bootClasspath)
setBootClasspath
in interface MinimalJavadocOptions
public MinimalJavadocOptions bootClasspath(java.io.File... bootClasspath)
bootClasspath
in interface MinimalJavadocOptions
public java.util.List<java.io.File> getExtDirs()
Specifies the directories where extension classes reside. These are any classes that use the Java Extension mechanism. The extdirs is part of the search path the Javadoc tool will use to look up source and class files. See -classpath (above) for more details. Separate directories in dirlist with semicolons (;).
getExtDirs
in interface MinimalJavadocOptions
public void setExtDirs(java.util.List<java.io.File> extDirs)
setExtDirs
in interface MinimalJavadocOptions
public MinimalJavadocOptions extDirs(java.io.File... extDirs)
extDirs
in interface MinimalJavadocOptions
public JavadocOutputLevel getOutputLevel()
getOutputLevel
in interface MinimalJavadocOptions
public void setOutputLevel(JavadocOutputLevel outputLevel)
setOutputLevel
in interface MinimalJavadocOptions
public MinimalJavadocOptions verbose()
verbose
in interface MinimalJavadocOptions
public boolean isVerbose()
isVerbose
in interface MinimalJavadocOptions
public MinimalJavadocOptions quiet()
quiet
in interface MinimalJavadocOptions
public boolean isBreakIterator()
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. By first sentence, we mean the first sentence in the main description of a package, class or member. This sentence is copied to the package, class or member summary, and to the alphabetic index.
From JDK 1.2 forward, the BreakIterator class is already used to determine the end of sentence for all languages but English. Therefore, the -breakiterator option has no effect except for English from 1.2 forward. English has its own default algorithm:
* English default sentence-break algorithm - Stops at a period followed by a space or a HTML block tag, such as <P>.
* Breakiterator sentence-break algorithm - In general, stops at a period, question mark or exclamation mark followed by a space if the next word starts with a capital letter. This is meant to handle most abbreviations (such as "The serial no. is valid", but won't handle "Mr. Smith"). Doesn't stop at HTML tags or sentences that begin with numbers or symbols. Stops at the last period in "../filename", even if embedded in an HTML tag.
NOTE: We have removed from 1.5.0 the breakiterator warning messages that were in 1.4.x and have left the default sentence-break algorithm unchanged. That is, the -breakiterator option is not the default in 1.5.0, nor do we expect it to become the default. This is a reversal from our former intention that the default would change in the "next major release" (1.5.0). This means if you have not modified your source code to eliminate the breakiterator warnings in 1.4.x, then you don't have to do anything, and the warnings go away starting with 1.5.0. The reason for this reversal is because any benefit to having breakiterator become the default would be outweighed by the incompatible source change it would require. We regret any extra work and confusion this has caused.
isBreakIterator
in interface MinimalJavadocOptions
public void setBreakIterator(boolean breakIterator)
setBreakIterator
in interface MinimalJavadocOptions
public MinimalJavadocOptions breakIterator(boolean breakIterator)
breakIterator
in interface MinimalJavadocOptions
public MinimalJavadocOptions breakIterator()
breakIterator
in interface MinimalJavadocOptions
public java.lang.String getLocale()
Important - The -locale option must be placed ahead (to the left) of any options provided by the standard doclet or any other doclet. Otherwise, the navigation bars will appear in English. This is the only command-line option that is order-dependent.
Specifies the locale that javadoc uses when generating documentation. The argument is the name of the locale, as described in java.util.Locale documentation, such as en_US (English, United States) or en_US_WIN (Windows variant).
Specifying a locale causes javadoc to choose the resource files of that locale for messages (strings in the navigation bar, headings for lists and tables, help file contents, comments in stylesheet.css, and so forth). It also specifies the sorting order for lists sorted alphabetically, and the sentence separator to determine the end of the first sentence. It does not determine the locale of the doc comment text specified in the source files of the documented classes.
getLocale
in interface MinimalJavadocOptions
public void setLocale(java.lang.String locale)
setLocale
in interface MinimalJavadocOptions
public MinimalJavadocOptions locale(java.lang.String locale)
locale
in interface MinimalJavadocOptions
public java.lang.String getEncoding()
Specifies the encoding name of the source files, such as EUCJIS/SJIS. If this option is not specified, the platform default converter is used.
Also see -docencoding and -charset.
getEncoding
in interface MinimalJavadocOptions
public void setEncoding(java.lang.String encoding)
setEncoding
in interface MinimalJavadocOptions
public MinimalJavadocOptions encoding(java.lang.String encoding)
encoding
in interface MinimalJavadocOptions
public java.util.List<java.lang.String> getSourceNames()
getSourceNames
in interface MinimalJavadocOptions
public void setSourceNames(java.util.List<java.lang.String> sourceNames)
setSourceNames
in interface MinimalJavadocOptions
public MinimalJavadocOptions sourceNames(java.lang.String... sourceNames)
sourceNames
in interface MinimalJavadocOptions
public java.util.List<java.lang.String> getJFlags()
Passes flag directly to the runtime system java that runs javadoc. Notice there must be no space between the J and the flag. For example, if you need to ensure that the system sets aside 32 megabytes of memory in which to process the generated documentation, then you would call the -Xmx option of java as follows (-Xms is optional, as it only sets the size of initial memory, which is useful if you know the minimum amount of memory required):
javadoc -J-Xmx32m -J-Xms32m com.mypackage
To tell what version of javadoc you are using, call the "-version" option of java:
javadoc -J-version java version "1.2" Classic VM (build JDK-1.2-V, green threads, sunwjit)
(The version number of the standard doclet appears in its output stream.)
getJFlags
in interface MinimalJavadocOptions
public void setJFlags(java.util.List<java.lang.String> jFlags)
setJFlags
in interface MinimalJavadocOptions
public MinimalJavadocOptions jFlags(java.lang.String... jFlags)
jFlags
in interface MinimalJavadocOptions
public void contributeCommandLineOptions(ExecSpec execHandleBuilder)
contributeCommandLineOptions
in interface MinimalJavadocOptions
public java.util.List<java.io.File> getOptionFiles()
getOptionFiles
in interface MinimalJavadocOptions
public void setOptionFiles(java.util.List<java.io.File> optionFiles)
setOptionFiles
in interface MinimalJavadocOptions
public MinimalJavadocOptions optionFiles(java.io.File... argumentFiles)
optionFiles
in interface MinimalJavadocOptions
public final void write(java.io.File outputFile) throws java.io.IOException
write
in interface MinimalJavadocOptions
java.io.IOException
public <T> JavadocOptionFileOption<T> addOption(JavadocOptionFileOption<T> option)
public JavadocOptionFileOption<java.lang.String> addStringOption(java.lang.String option)
public JavadocOptionFileOption<java.lang.String> addStringOption(java.lang.String option, java.lang.String value)
public <T extends java.lang.Enum<T>> JavadocOptionFileOption<T> addEnumOption(java.lang.String option)
public <T extends java.lang.Enum<T>> JavadocOptionFileOption<T> addEnumOption(java.lang.String option, T value)
public JavadocOptionFileOption<java.util.List<java.io.File>> addPathOption(java.lang.String option)
public JavadocOptionFileOption<java.util.List<java.io.File>> addPathOption(java.lang.String option, java.lang.String joinBy)
public JavadocOptionFileOption<java.util.List<java.lang.String>> addStringsOption(java.lang.String option)
public JavadocOptionFileOption<java.util.List<java.lang.String>> addStringsOption(java.lang.String option, java.lang.String joinBy)
addStringsOption("foo", ",").setValue(["a", "b", "c"])
will produce the command-line
-foo 'a,b,c'
option
- command-line optionjoinBy
- separatorpublic JavadocOptionFileOption<java.util.List<java.lang.String>> addMultilineStringsOption(java.lang.String option)
addMultilineStringsOption("foo").setValue(["a", "b", "c"])
will produce the command-line
-foo 'a' -foo 'b' -foo 'c'
option
- command-line optionpublic JavadocOptionFileOption<java.util.List<java.util.List<java.lang.String>>> addMultilineMultiValueOption(java.lang.String option)
addMultilineMultiValueOption("foo").setValue([ ["a"], ["b", "c"] ])
will produce the command-line
-foo 'a' -foo 'b' 'c'
option
- command-line optionpublic JavadocOptionFileOption<java.lang.Boolean> addBooleanOption(java.lang.String option)
public JavadocOptionFileOption<java.lang.Boolean> addBooleanOption(java.lang.String option, boolean value)
public JavadocOptionFileOption<java.io.File> addFileOption(java.lang.String option)
public JavadocOptionFileOption<java.io.File> addFileOption(java.lang.String option, java.io.File value)
@Incubating @Input protected java.lang.String getExtraOptions()