MinimalJavadocOptions
public class StandardJavadocDocletOptions extends CoreJavadocOptions implements MinimalJavadocOptions
Modifier and Type | Field | Description |
---|---|---|
JavadocOptionFileOption<java.lang.Boolean> |
noTimestamp |
optionFile
Constructor | Description |
---|---|
StandardJavadocDocletOptions() |
|
StandardJavadocDocletOptions(org.gradle.external.javadoc.internal.JavadocOptionFile javadocOptionFile) |
|
StandardJavadocDocletOptions(MinimalJavadocOptions original) |
|
StandardJavadocDocletOptions(StandardJavadocDocletOptions original) |
|
StandardJavadocDocletOptions(StandardJavadocDocletOptions original,
org.gradle.external.javadoc.internal.JavadocOptionFile optionFile) |
Modifier and Type | Method | Description |
---|---|---|
StandardJavadocDocletOptions |
author() |
|
StandardJavadocDocletOptions |
author(boolean author) |
|
StandardJavadocDocletOptions |
bottom(java.lang.String bottom) |
|
StandardJavadocDocletOptions |
charSet(java.lang.String charSet) |
|
StandardJavadocDocletOptions |
destinationDirectory(java.io.File destinationDirectory) |
|
StandardJavadocDocletOptions |
docEncoding(java.lang.String docEncoding) |
|
StandardJavadocDocletOptions |
docFilesSubDirs() |
|
StandardJavadocDocletOptions |
docFilesSubDirs(boolean docFilesSubDirs) |
|
StandardJavadocDocletOptions |
docTitle(java.lang.String docTitle) |
|
StandardJavadocDocletOptions |
excludeDocFilesSubDir(java.lang.String... excludeDocFilesSubDir) |
|
StandardJavadocDocletOptions |
excludeDocFilesSubDir(java.util.List<java.lang.String> excludeDocFilesSubDir) |
|
StandardJavadocDocletOptions |
footer(java.lang.String footer) |
|
java.lang.String |
getBottom() |
|
java.lang.String |
getCharSet() |
|
java.io.File |
getDestinationDirectory() |
|
java.lang.String |
getDocEncoding() |
|
java.lang.String |
getDocTitle() |
|
java.util.List<java.lang.String> |
getExcludeDocFilesSubDir() |
|
java.lang.String |
getFooter() |
|
java.util.Map<java.lang.String,java.util.List<java.lang.String>> |
getGroups() |
|
java.lang.String |
getHeader() |
|
java.io.File |
getHelpFile() |
|
java.util.List<java.lang.String> |
getLinks() |
|
java.util.List<JavadocOfflineLink> |
getLinksOffline() |
|
java.util.List<java.lang.String> |
getNoQualifiers() |
|
java.io.File |
getStylesheetFile() |
|
java.util.List<java.io.File> |
getTagletPath() |
|
java.util.List<java.lang.String> |
getTaglets() |
|
java.util.List<java.lang.String> |
getTags() |
|
java.lang.String |
getWindowTitle() |
|
StandardJavadocDocletOptions |
group(java.lang.String groupName,
java.lang.String... packagePatterns) |
|
StandardJavadocDocletOptions |
group(java.lang.String groupName,
java.util.List<java.lang.String> packagePatterns) |
|
StandardJavadocDocletOptions |
group(java.util.Map<java.lang.String,java.util.List<java.lang.String>> groups) |
|
StandardJavadocDocletOptions |
groupsFile(java.io.File groupsFile) |
|
StandardJavadocDocletOptions |
header(java.lang.String header) |
|
StandardJavadocDocletOptions |
helpFile(java.io.File helpFile) |
|
boolean |
isAuthor() |
|
boolean |
isDocFilesSubDirs() |
|
boolean |
isKeyWords() |
|
boolean |
isLinkSource() |
|
boolean |
isNoComment() |
|
boolean |
isNoDeprecated() |
|
boolean |
isNoDeprecatedList() |
|
boolean |
isNoHelp() |
|
boolean |
isNoIndex() |
|
boolean |
isNoNavBar() |
|
boolean |
isNoSince() |
|
boolean |
isNoTimestamp() |
|
boolean |
isNoTree() |
|
boolean |
isSerialWarn() |
|
boolean |
isSplitIndex() |
|
boolean |
isUse() |
|
boolean |
isVersion() |
|
StandardJavadocDocletOptions |
keyWords() |
|
StandardJavadocDocletOptions |
keyWords(boolean keyWords) |
|
StandardJavadocDocletOptions |
links(java.lang.String... links) |
|
StandardJavadocDocletOptions |
linksFile(java.io.File linksFile) |
|
StandardJavadocDocletOptions |
linksOffline(java.lang.String extDocUrl,
java.lang.String packageListLoc) |
|
StandardJavadocDocletOptions |
linksOfflineFile(java.io.File linksOfflineFile) |
|
StandardJavadocDocletOptions |
linkSource() |
|
StandardJavadocDocletOptions |
linkSource(boolean linkSource) |
|
StandardJavadocDocletOptions |
noComment() |
|
StandardJavadocDocletOptions |
noComment(boolean noComment) |
|
StandardJavadocDocletOptions |
noDeprecated() |
|
StandardJavadocDocletOptions |
noDeprecated(boolean nodeprecated) |
|
StandardJavadocDocletOptions |
noDeprecatedList() |
|
StandardJavadocDocletOptions |
noDeprecatedList(boolean noDeprecatedList) |
|
StandardJavadocDocletOptions |
noHelp() |
|
StandardJavadocDocletOptions |
noHelp(boolean noHelp) |
|
StandardJavadocDocletOptions |
noIndex() |
|
StandardJavadocDocletOptions |
noIndex(boolean noIndex) |
|
StandardJavadocDocletOptions |
noNavBar() |
|
StandardJavadocDocletOptions |
noNavBar(boolean noNavBar) |
|
StandardJavadocDocletOptions |
noQualifier(java.util.List<java.lang.String> noQualifiers) |
|
StandardJavadocDocletOptions |
noQualifiers(java.lang.String... noQualifiers) |
|
StandardJavadocDocletOptions |
noSince() |
|
StandardJavadocDocletOptions |
noSince(boolean noSince) |
|
StandardJavadocDocletOptions |
noTimestamp() |
|
StandardJavadocDocletOptions |
noTimestamp(boolean noTimestamp) |
|
StandardJavadocDocletOptions |
noTree() |
|
StandardJavadocDocletOptions |
noTree(boolean noTree) |
|
StandardJavadocDocletOptions |
serialWarn() |
|
StandardJavadocDocletOptions |
serialWarn(boolean serialWarn) |
|
void |
setAuthor(boolean author) |
|
void |
setBottom(java.lang.String bottom) |
|
void |
setCharSet(java.lang.String charSet) |
|
void |
setDestinationDirectory(java.io.File directory) |
|
void |
setDocEncoding(java.lang.String docEncoding) |
|
void |
setDocFilesSubDirs(boolean docFilesSubDirs) |
|
void |
setDocTitle(java.lang.String docTitle) |
|
void |
setExcludeDocFilesSubDir(java.util.List<java.lang.String> excludeDocFilesSubDir) |
|
void |
setFooter(java.lang.String footer) |
|
void |
setGroups(java.util.Map<java.lang.String,java.util.List<java.lang.String>> groups) |
|
void |
setHeader(java.lang.String header) |
|
void |
setHelpFile(java.io.File helpFile) |
|
void |
setKeyWords(boolean keyWords) |
|
void |
setLinks(java.util.List<java.lang.String> links) |
|
void |
setLinksOffline(java.util.List<JavadocOfflineLink> linksOffline) |
|
void |
setLinkSource(boolean linkSource) |
|
void |
setNoComment(boolean noComment) |
|
void |
setNoDeprecated(boolean noDeprecated) |
|
void |
setNoDeprecatedList(boolean noDeprecatedList) |
|
void |
setNoHelp(boolean noHelp) |
|
void |
setNoIndex(boolean noIndex) |
|
void |
setNoNavBar(boolean noNavBar) |
|
void |
setNoQualifiers(java.util.List<java.lang.String> noQualifiers) |
|
void |
setNoSince(boolean noSince) |
|
void |
setNoTimestamp(boolean noTimestamp) |
|
void |
setNoTree(boolean noTree) |
|
void |
setSerialWarn(boolean serialWarn) |
|
void |
setSplitIndex(boolean splitIndex) |
|
void |
setStylesheetFile(java.io.File stylesheetFile) |
|
void |
setTagletPath(java.util.List<java.io.File> tagletPath) |
|
void |
setTaglets(java.util.List<java.lang.String> taglets) |
|
void |
setTags(java.util.List<java.lang.String> tags) |
|
void |
setUse(boolean use) |
|
void |
setVersion(boolean version) |
|
void |
setWindowTitle(java.lang.String windowTitle) |
|
StandardJavadocDocletOptions |
splitIndex() |
|
StandardJavadocDocletOptions |
splitIndex(boolean splitIndex) |
|
StandardJavadocDocletOptions |
stylesheetFile(java.io.File stylesheetFile) |
|
StandardJavadocDocletOptions |
tagletPath(java.io.File... tagletPath) |
|
StandardJavadocDocletOptions |
tagletPath(java.util.List<java.io.File> tagletPath) |
|
StandardJavadocDocletOptions |
taglets(java.lang.String... taglets) |
|
StandardJavadocDocletOptions |
taglets(java.util.List<java.lang.String> taglets) |
|
StandardJavadocDocletOptions |
tags(java.lang.String... tags) |
|
StandardJavadocDocletOptions |
tags(java.util.List<java.lang.String> tags) |
|
StandardJavadocDocletOptions |
tagsFile(java.io.File tagsFile) |
|
StandardJavadocDocletOptions |
use() |
|
StandardJavadocDocletOptions |
use(boolean use) |
|
StandardJavadocDocletOptions |
version() |
|
StandardJavadocDocletOptions |
version(boolean version) |
|
StandardJavadocDocletOptions |
windowTitle(java.lang.String windowTitle) |
addBooleanOption, addBooleanOption, addEnumOption, addEnumOption, addFileOption, addFileOption, addMultilineStringsOption, addOption, addPathOption, addPathOption, addStringOption, addStringOption, addStringsOption, addStringsOption, bootClasspath, breakIterator, breakIterator, classpath, classpath, contributeCommandLineOptions, doclet, docletpath, encoding, extDirs, getBootClasspath, getClasspath, getDoclet, getDocletpath, getEncoding, getExtDirs, getJFlags, getLocale, getMemberLevel, getOptionFiles, getOutputLevel, getOverview, getSource, getSourceNames, isBreakIterator, isVerbose, jFlags, locale, optionFiles, overview, quiet, setBootClasspath, setBreakIterator, setClasspath, setDoclet, setDocletpath, setEncoding, setExtDirs, setJFlags, setLocale, setMemberLevel, setOptionFiles, setOutputLevel, setOverview, setSource, setSourceNames, showAll, showFromPackage, showFromPrivate, showFromProtected, showFromPublic, source, sourceNames, verbose, write
bootClasspath, breakIterator, breakIterator, classpath, classpath, contributeCommandLineOptions, doclet, docletpath, encoding, extDirs, getBootClasspath, getClasspath, getDoclet, getDocletpath, getEncoding, getExtDirs, getJFlags, getLocale, getMemberLevel, getOptionFiles, getOutputLevel, getOverview, getSource, getSourceNames, isBreakIterator, isVerbose, jFlags, locale, optionFiles, overview, quiet, setBootClasspath, setBreakIterator, setClasspath, setDoclet, setDocletpath, setEncoding, setExtDirs, setJFlags, setLocale, setMemberLevel, setOptionFiles, setOutputLevel, setOverview, setSource, setSourceNames, showAll, showFromPackage, showFromPrivate, showFromProtected, showFromPublic, source, sourceNames, verbose, write
public final JavadocOptionFileOption<java.lang.Boolean> noTimestamp
public StandardJavadocDocletOptions()
public StandardJavadocDocletOptions(org.gradle.external.javadoc.internal.JavadocOptionFile javadocOptionFile)
public StandardJavadocDocletOptions(StandardJavadocDocletOptions original)
public StandardJavadocDocletOptions(StandardJavadocDocletOptions original, org.gradle.external.javadoc.internal.JavadocOptionFile optionFile)
public StandardJavadocDocletOptions(MinimalJavadocOptions original)
public java.io.File getDestinationDirectory()
getDestinationDirectory
in interface MinimalJavadocOptions
public void setDestinationDirectory(java.io.File directory)
setDestinationDirectory
in interface MinimalJavadocOptions
public StandardJavadocDocletOptions destinationDirectory(java.io.File destinationDirectory)
destinationDirectory
in interface MinimalJavadocOptions
@Input public boolean isUse()
public void setUse(boolean use)
public StandardJavadocDocletOptions use(boolean use)
public StandardJavadocDocletOptions use()
@Input public boolean isVersion()
public void setVersion(boolean version)
public StandardJavadocDocletOptions version(boolean version)
public StandardJavadocDocletOptions version()
@Input public boolean isAuthor()
public void setAuthor(boolean author)
public StandardJavadocDocletOptions author(boolean author)
public StandardJavadocDocletOptions author()
@Input public boolean isSplitIndex()
public void setSplitIndex(boolean splitIndex)
public StandardJavadocDocletOptions splitIndex(boolean splitIndex)
public StandardJavadocDocletOptions splitIndex()
public java.lang.String getWindowTitle()
getWindowTitle
in interface MinimalJavadocOptions
public void setWindowTitle(java.lang.String windowTitle)
setWindowTitle
in interface MinimalJavadocOptions
public StandardJavadocDocletOptions windowTitle(java.lang.String windowTitle)
windowTitle
in interface MinimalJavadocOptions
public java.lang.String getHeader()
getHeader
in interface MinimalJavadocOptions
public void setHeader(java.lang.String header)
setHeader
in interface MinimalJavadocOptions
public StandardJavadocDocletOptions header(java.lang.String header)
header
in interface MinimalJavadocOptions
public void setDocTitle(java.lang.String docTitle)
public StandardJavadocDocletOptions docTitle(java.lang.String docTitle)
public void setFooter(java.lang.String footer)
public StandardJavadocDocletOptions footer(java.lang.String footer)
public void setBottom(java.lang.String bottom)
public StandardJavadocDocletOptions bottom(java.lang.String bottom)
public void setLinks(java.util.List<java.lang.String> links)
public StandardJavadocDocletOptions links(java.lang.String... links)
public StandardJavadocDocletOptions linksFile(java.io.File linksFile)
@Optional @Input public java.util.List<JavadocOfflineLink> getLinksOffline()
public void setLinksOffline(java.util.List<JavadocOfflineLink> linksOffline)
public StandardJavadocDocletOptions linksOffline(java.lang.String extDocUrl, java.lang.String packageListLoc)
public StandardJavadocDocletOptions linksOfflineFile(java.io.File linksOfflineFile)
@Input public boolean isLinkSource()
public void setLinkSource(boolean linkSource)
public StandardJavadocDocletOptions linkSource(boolean linkSource)
public StandardJavadocDocletOptions linkSource()
@Optional @Input public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getGroups()
public void setGroups(java.util.Map<java.lang.String,java.util.List<java.lang.String>> groups)
public StandardJavadocDocletOptions group(java.util.Map<java.lang.String,java.util.List<java.lang.String>> groups)
public StandardJavadocDocletOptions group(java.lang.String groupName, java.util.List<java.lang.String> packagePatterns)
public StandardJavadocDocletOptions group(java.lang.String groupName, java.lang.String... packagePatterns)
public StandardJavadocDocletOptions groupsFile(java.io.File groupsFile)
@Input public boolean isNoDeprecated()
public void setNoDeprecated(boolean noDeprecated)
public StandardJavadocDocletOptions noDeprecated(boolean nodeprecated)
public StandardJavadocDocletOptions noDeprecated()
@Input public boolean isNoDeprecatedList()
public void setNoDeprecatedList(boolean noDeprecatedList)
public StandardJavadocDocletOptions noDeprecatedList(boolean noDeprecatedList)
public StandardJavadocDocletOptions noDeprecatedList()
@Input public boolean isNoSince()
public void setNoSince(boolean noSince)
public StandardJavadocDocletOptions noSince(boolean noSince)
public StandardJavadocDocletOptions noSince()
@Input public boolean isNoTree()
public void setNoTree(boolean noTree)
public StandardJavadocDocletOptions noTree(boolean noTree)
public StandardJavadocDocletOptions noTree()
@Input public boolean isNoIndex()
public void setNoIndex(boolean noIndex)
public StandardJavadocDocletOptions noIndex(boolean noIndex)
public StandardJavadocDocletOptions noIndex()
@Input public boolean isNoHelp()
public void setNoHelp(boolean noHelp)
public StandardJavadocDocletOptions noHelp(boolean noHelp)
public StandardJavadocDocletOptions noHelp()
@Input public boolean isNoNavBar()
public void setNoNavBar(boolean noNavBar)
public StandardJavadocDocletOptions noNavBar(boolean noNavBar)
public StandardJavadocDocletOptions noNavBar()
@Optional @PathSensitive(NAME_ONLY) @InputFile public java.io.File getHelpFile()
public void setHelpFile(java.io.File helpFile)
public StandardJavadocDocletOptions helpFile(java.io.File helpFile)
@Optional @PathSensitive(NAME_ONLY) @InputFile public java.io.File getStylesheetFile()
public void setStylesheetFile(java.io.File stylesheetFile)
public StandardJavadocDocletOptions stylesheetFile(java.io.File stylesheetFile)
@Input public boolean isSerialWarn()
public void setSerialWarn(boolean serialWarn)
public StandardJavadocDocletOptions serialWarn(boolean serialWarn)
public StandardJavadocDocletOptions serialWarn()
public void setCharSet(java.lang.String charSet)
public StandardJavadocDocletOptions charSet(java.lang.String charSet)
public void setDocEncoding(java.lang.String docEncoding)
public StandardJavadocDocletOptions docEncoding(java.lang.String docEncoding)
@Input public boolean isKeyWords()
public void setKeyWords(boolean keyWords)
public StandardJavadocDocletOptions keyWords(boolean keyWords)
public StandardJavadocDocletOptions keyWords()
public void setTags(java.util.List<java.lang.String> tags)
public StandardJavadocDocletOptions tags(java.util.List<java.lang.String> tags)
public StandardJavadocDocletOptions tags(java.lang.String... tags)
public StandardJavadocDocletOptions tagsFile(java.io.File tagsFile)
public void setTaglets(java.util.List<java.lang.String> taglets)
public StandardJavadocDocletOptions taglets(java.util.List<java.lang.String> taglets)
public StandardJavadocDocletOptions taglets(java.lang.String... taglets)
@Optional @Classpath public java.util.List<java.io.File> getTagletPath()
public void setTagletPath(java.util.List<java.io.File> tagletPath)
public StandardJavadocDocletOptions tagletPath(java.util.List<java.io.File> tagletPath)
public StandardJavadocDocletOptions tagletPath(java.io.File... tagletPath)
@Input public boolean isDocFilesSubDirs()
public void setDocFilesSubDirs(boolean docFilesSubDirs)
public StandardJavadocDocletOptions docFilesSubDirs(boolean docFilesSubDirs)
public StandardJavadocDocletOptions docFilesSubDirs()
@Optional @Input public java.util.List<java.lang.String> getExcludeDocFilesSubDir()
public void setExcludeDocFilesSubDir(java.util.List<java.lang.String> excludeDocFilesSubDir)
public StandardJavadocDocletOptions excludeDocFilesSubDir(java.util.List<java.lang.String> excludeDocFilesSubDir)
public StandardJavadocDocletOptions excludeDocFilesSubDir(java.lang.String... excludeDocFilesSubDir)
public void setNoQualifiers(java.util.List<java.lang.String> noQualifiers)
public StandardJavadocDocletOptions noQualifier(java.util.List<java.lang.String> noQualifiers)
public StandardJavadocDocletOptions noQualifiers(java.lang.String... noQualifiers)
@Input public boolean isNoTimestamp()
public void setNoTimestamp(boolean noTimestamp)
public StandardJavadocDocletOptions noTimestamp(boolean noTimestamp)
public StandardJavadocDocletOptions noTimestamp()
@Input public boolean isNoComment()
public void setNoComment(boolean noComment)
public StandardJavadocDocletOptions noComment(boolean noComment)
public StandardJavadocDocletOptions noComment()