org.gradle.external.javadoc
Class StandardJavadocDocletOptions
java.lang.Object
org.gradle.external.javadoc.CoreJavadocOptions
org.gradle.external.javadoc.StandardJavadocDocletOptions
- All Implemented Interfaces:
- MinimalJavadocOptions
public class StandardJavadocDocletOptions
- extends CoreJavadocOptions
- implements MinimalJavadocOptions
Provides the options for the standard Javadoc doclet.
Methods inherited from class org.gradle.external.javadoc.CoreJavadocOptions |
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 |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.gradle.external.javadoc.MinimalJavadocOptions |
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 |
noTimestamp
public final JavadocOptionFileOption<Boolean> noTimestamp
StandardJavadocDocletOptions
public StandardJavadocDocletOptions()
StandardJavadocDocletOptions
public StandardJavadocDocletOptions(org.gradle.external.javadoc.internal.JavadocOptionFile javadocOptionFile)
getDestinationDirectory
public File getDestinationDirectory()
- Specified by:
getDestinationDirectory
in interface MinimalJavadocOptions
setDestinationDirectory
public void setDestinationDirectory(File directory)
- Specified by:
setDestinationDirectory
in interface MinimalJavadocOptions
destinationDirectory
public StandardJavadocDocletOptions destinationDirectory(File destinationDirectory)
- Specified by:
destinationDirectory
in interface MinimalJavadocOptions
isUse
public boolean isUse()
setUse
public void setUse(boolean use)
use
public StandardJavadocDocletOptions use(boolean use)
use
public StandardJavadocDocletOptions use()
isVersion
public boolean isVersion()
setVersion
public void setVersion(boolean version)
version
public StandardJavadocDocletOptions version(boolean version)
version
public StandardJavadocDocletOptions version()
isAuthor
public boolean isAuthor()
setAuthor
public void setAuthor(boolean author)
author
public StandardJavadocDocletOptions author(boolean author)
author
public StandardJavadocDocletOptions author()
isSplitIndex
public boolean isSplitIndex()
setSplitIndex
public void setSplitIndex(boolean splitIndex)
splitIndex
public StandardJavadocDocletOptions splitIndex(boolean splitIndex)
splitIndex
public StandardJavadocDocletOptions splitIndex()
getWindowTitle
public String getWindowTitle()
- Specified by:
getWindowTitle
in interface MinimalJavadocOptions
setWindowTitle
public void setWindowTitle(String windowTitle)
- Specified by:
setWindowTitle
in interface MinimalJavadocOptions
windowTitle
public StandardJavadocDocletOptions windowTitle(String windowTitle)
- Specified by:
windowTitle
in interface MinimalJavadocOptions
getHeader
public String getHeader()
- Specified by:
getHeader
in interface MinimalJavadocOptions
setHeader
public void setHeader(String header)
- Specified by:
setHeader
in interface MinimalJavadocOptions
header
public StandardJavadocDocletOptions header(String header)
- Specified by:
header
in interface MinimalJavadocOptions
getDocTitle
public String getDocTitle()
setDocTitle
public void setDocTitle(String docTitle)
docTitle
public StandardJavadocDocletOptions docTitle(String docTitle)
getFooter
public String getFooter()
setFooter
public void setFooter(String footer)
footer
public StandardJavadocDocletOptions footer(String footer)
getBottom
public String getBottom()
setBottom
public void setBottom(String bottom)
bottom
public StandardJavadocDocletOptions bottom(String bottom)
getLinks
public List<String> getLinks()
setLinks
public void setLinks(List<String> links)
links
public StandardJavadocDocletOptions links(String... links)
linksFile
public StandardJavadocDocletOptions linksFile(File linksFile)
getLinksOffline
public List<JavadocOfflineLink> getLinksOffline()
setLinksOffline
public void setLinksOffline(List<JavadocOfflineLink> linksOffline)
linksOffline
public StandardJavadocDocletOptions linksOffline(String extDocUrl,
String packageListLoc)
linksOfflineFile
public StandardJavadocDocletOptions linksOfflineFile(File linksOfflineFile)
isLinkSource
public boolean isLinkSource()
setLinkSource
public void setLinkSource(boolean linkSource)
linkSource
public StandardJavadocDocletOptions linkSource(boolean linkSource)
linkSource
public StandardJavadocDocletOptions linkSource()
getGroups
public Map<String,List<String>> getGroups()
setGroups
public void setGroups(Map<String,List<String>> groups)
group
public StandardJavadocDocletOptions group(Map<String,List<String>> groups)
group
public StandardJavadocDocletOptions group(String groupName,
List<String> packagePatterns)
group
public StandardJavadocDocletOptions group(String groupName,
String... packagePatterns)
groupsFile
public StandardJavadocDocletOptions groupsFile(File groupsFile)
isNoDeprecated
public boolean isNoDeprecated()
setNoDeprecated
public void setNoDeprecated(boolean noDeprecated)
noDeprecated
public StandardJavadocDocletOptions noDeprecated(boolean nodeprecated)
noDeprecated
public StandardJavadocDocletOptions noDeprecated()
isNoDeprecatedList
public boolean isNoDeprecatedList()
setNoDeprecatedList
public void setNoDeprecatedList(boolean noDeprecatedList)
noDeprecatedList
public StandardJavadocDocletOptions noDeprecatedList(boolean noDeprecatedList)
noDeprecatedList
public StandardJavadocDocletOptions noDeprecatedList()
isNoSince
public boolean isNoSince()
setNoSince
public void setNoSince(boolean noSince)
noSince
public StandardJavadocDocletOptions noSince(boolean noSince)
noSince
public StandardJavadocDocletOptions noSince()
isNoTree
public boolean isNoTree()
setNoTree
public void setNoTree(boolean noTree)
noTree
public StandardJavadocDocletOptions noTree(boolean noTree)
noTree
public StandardJavadocDocletOptions noTree()
isNoIndex
public boolean isNoIndex()
setNoIndex
public void setNoIndex(boolean noIndex)
noIndex
public StandardJavadocDocletOptions noIndex(boolean noIndex)
noIndex
public StandardJavadocDocletOptions noIndex()
isNoHelp
public boolean isNoHelp()
setNoHelp
public void setNoHelp(boolean noHelp)
noHelp
public StandardJavadocDocletOptions noHelp(boolean noHelp)
noHelp
public StandardJavadocDocletOptions noHelp()
isNoNavBar
public boolean isNoNavBar()
setNoNavBar
public void setNoNavBar(boolean noNavBar)
noNavBar
public StandardJavadocDocletOptions noNavBar(boolean noNavBar)
noNavBar
public StandardJavadocDocletOptions noNavBar()
getHelpFile
public File getHelpFile()
setHelpFile
public void setHelpFile(File helpFile)
helpFile
public StandardJavadocDocletOptions helpFile(File helpFile)
getStylesheetFile
public File getStylesheetFile()
setStylesheetFile
public void setStylesheetFile(File stylesheetFile)
stylesheetFile
public StandardJavadocDocletOptions stylesheetFile(File stylesheetFile)
isSerialWarn
public boolean isSerialWarn()
setSerialWarn
public void setSerialWarn(boolean serialWarn)
serialWarn
public StandardJavadocDocletOptions serialWarn(boolean serialWarn)
serialWarn
public StandardJavadocDocletOptions serialWarn()
getCharSet
public String getCharSet()
setCharSet
public void setCharSet(String charSet)
charSet
public StandardJavadocDocletOptions charSet(String charSet)
getDocEncoding
public String getDocEncoding()
setDocEncoding
public void setDocEncoding(String docEncoding)
docEncoding
public StandardJavadocDocletOptions docEncoding(String docEncoding)
isKeyWords
public boolean isKeyWords()
setKeyWords
public void setKeyWords(boolean keyWords)
keyWords
public StandardJavadocDocletOptions keyWords(boolean keyWords)
keyWords
public StandardJavadocDocletOptions keyWords()
getTags
public List<String> getTags()
setTags
public void setTags(List<String> tags)
tags
public StandardJavadocDocletOptions tags(List<String> tags)
tags
public StandardJavadocDocletOptions tags(String... tags)
taglets
public StandardJavadocDocletOptions taglets(String... taglets)
tagsFile
public StandardJavadocDocletOptions tagsFile(File tagsFile)
getTagletPath
public List<File> getTagletPath()
setTagletPath
public void setTagletPath(List<File> tagletPath)
tagletPath
public StandardJavadocDocletOptions tagletPath(List<File> tagletPath)
tagletPath
public StandardJavadocDocletOptions tagletPath(File... tagletPath)
isDocFilesSubDirs
public boolean isDocFilesSubDirs()
setDocFilesSubDirs
public void setDocFilesSubDirs(boolean docFilesSubDirs)
docFilesSubDirs
public StandardJavadocDocletOptions docFilesSubDirs(boolean docFilesSubDirs)
docFilesSubDirs
public StandardJavadocDocletOptions docFilesSubDirs()
getExcludeDocFilesSubDir
public List<String> getExcludeDocFilesSubDir()
setExcludeDocFilesSubDir
public void setExcludeDocFilesSubDir(List<String> excludeDocFilesSubDir)
excludeDocFilesSubDir
public StandardJavadocDocletOptions excludeDocFilesSubDir(List<String> excludeDocFilesSubDir)
excludeDocFilesSubDir
public StandardJavadocDocletOptions excludeDocFilesSubDir(String... excludeDocFilesSubDir)
getNoQualifiers
public List<String> getNoQualifiers()
setNoQualifiers
public void setNoQualifiers(List<String> noQualifiers)
noQualifier
public StandardJavadocDocletOptions noQualifier(List<String> noQualifiers)
noQualifiers
public StandardJavadocDocletOptions noQualifiers(String... noQualifiers)
isNoTimestamp
public boolean isNoTimestamp()
setNoTimestamp
public void setNoTimestamp(boolean noTimestamp)
noTimestamp
public StandardJavadocDocletOptions noTimestamp(boolean noTimestamp)
noTimestamp
public StandardJavadocDocletOptions noTimestamp()
isNoComment
public boolean isNoComment()
setNoComment
public void setNoComment(boolean noComment)
noComment
public StandardJavadocDocletOptions noComment(boolean noComment)
noComment
public StandardJavadocDocletOptions noComment()