Overview | Package | Class | Deprecated | Index | Help
| Groovy Documentation
| FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.gradle.external.javadoc
[Java] Class StandardJavadocDocletOptions

    java.lang.Object
      org.gradle.external.javadoc.CoreJavadocOptions
          org.gradle.external.javadoc.StandardJavadocDocletOptions

All Implemented Interfaces:
  MinimalJavadocOptions

    public class StandardJavadocDocletOptions
    extends CoreJavadocOptions

Provides the options for the standard Javadoc doclet.

Authors:
  Tom Eyckmans

Field Summary
`JavadocOptionFileOption` | `noTimestamp`

Constructor Summary
`StandardJavadocDocletOptions()`
`StandardJavadocDocletOptions(JavadocOptionFile javadocOptionFile)`

Method Summary
`StandardJavadocDocletOptions` | `author(boolean author)`
`StandardJavadocDocletOptions` | `author()`
`StandardJavadocDocletOptions` | `bottom(String bottom)`
`StandardJavadocDocletOptions` | `charSet(String charSet)`
`StandardJavadocDocletOptions` | `destinationDirectory(File destinationDirectory)`
`StandardJavadocDocletOptions` | `docEncoding(String docEncoding)`
`StandardJavadocDocletOptions` | `docFilesSubDirs(boolean docFilesSubDirs)`
`StandardJavadocDocletOptions` | `docFilesSubDirs()`
`StandardJavadocDocletOptions` | `docTitle(String docTitle)`
`StandardJavadocDocletOptions` | `excludeDocFilesSubDir(List excludeDocFilesSubDir)`
`StandardJavadocDocletOptions` | `excludeDocFilesSubDir(String... excludeDocFilesSubDir)`
`StandardJavadocDocletOptions` | `footer(String footer)`
`String` | `getBottom()`
`String` | `getCharSet()`
`File` | `getDestinationDirectory()`
`String` | `getDocEncoding()`
`String` | `getDocTitle()`
`List` | `getExcludeDocFilesSubDir()`
`String` | `getFooter()`
`Map` | `getGroups()`
`String` | `getHeader()`
`File` | `getHelpFile()`
`List` | `getLinks()`
`List` | `getLinksOffline()`
`List` | `getNoQualifiers()`
`File` | `getStylesheetFile()`
`List` | `getTagletPath()`
`List` | `getTaglets()`
`List` | `getTags()`
`String` | `getWindowTitle()`
`StandardJavadocDocletOptions` | `group(Map groups)`
`StandardJavadocDocletOptions` | `group(String groupName, List packagePatterns)`
`StandardJavadocDocletOptions` | `group(String groupName, String... packagePatterns)`
`StandardJavadocDocletOptions` | `groupsFile(File groupsFile)`
`StandardJavadocDocletOptions` | `header(String header)`
`StandardJavadocDocletOptions` | `helpFile(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(boolean keyWords)`
`StandardJavadocDocletOptions` | `keyWords()`
`StandardJavadocDocletOptions` | `linkSource(boolean linkSource)`
`StandardJavadocDocletOptions` | `linkSource()`
`StandardJavadocDocletOptions` | `links(String... links)`
`StandardJavadocDocletOptions` | `linksFile(File linksFile)`
`StandardJavadocDocletOptions` | `linksOffline(String extDocUrl, String packageListLoc)`
`StandardJavadocDocletOptions` | `linksOfflineFile(File linksOfflineFile)`
`StandardJavadocDocletOptions` | `noComment(boolean noComment)`
`StandardJavadocDocletOptions` | `noComment()`
`StandardJavadocDocletOptions` | `noDeprecated(boolean nodeprecated)`
`StandardJavadocDocletOptions` | `noDeprecated()`
`StandardJavadocDocletOptions` | `noDeprecatedList(boolean noDeprecatedList)`
`StandardJavadocDocletOptions` | `noDeprecatedList()`
`StandardJavadocDocletOptions` | `noHelp(boolean noHelp)`
`StandardJavadocDocletOptions` | `noHelp()`
`StandardJavadocDocletOptions` | `noIndex(boolean noIndex)`
`StandardJavadocDocletOptions` | `noIndex()`
`StandardJavadocDocletOptions` | `noNavBar(boolean noNavBar)`
`StandardJavadocDocletOptions` | `noNavBar()`
`StandardJavadocDocletOptions` | `noQualifier(List noQualifiers)`
`StandardJavadocDocletOptions` | `noQualifiers(String... noQualifiers)`
`StandardJavadocDocletOptions` | `noSince(boolean noSince)`
`StandardJavadocDocletOptions` | `noSince()`
`StandardJavadocDocletOptions` | `noTimestamp(boolean noTimestamp)`
`StandardJavadocDocletOptions` | `noTimestamp()`
`StandardJavadocDocletOptions` | `noTree(boolean noTree)`
`StandardJavadocDocletOptions` | `noTree()`
`StandardJavadocDocletOptions` | `serialWarn(boolean serialWarn)`
`StandardJavadocDocletOptions` | `serialWarn()`
`void` | `setAuthor(boolean author)`
`void` | `setBottom(String bottom)`
`void` | `setCharSet(String charSet)`
`void` | `setDestinationDirectory(File directory)`
`void` | `setDocEncoding(String docEncoding)`
`void` | `setDocFilesSubDirs(boolean docFilesSubDirs)`
`void` | `setDocTitle(String docTitle)`
`void` | `setExcludeDocFilesSubDir(List excludeDocFilesSubDir)`
`void` | `setFooter(String footer)`
`void` | `setGroups(Map groups)`
`void` | `setHeader(String header)`
`void` | `setHelpFile(File helpFile)`
`void` | `setKeyWords(boolean keyWords)`
`void` | `setLinkSource(boolean linkSource)`
`void` | `setLinks(List links)`
`void` | `setLinksOffline(List linksOffline)`
`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(List noQualifiers)`
`void` | `setNoSince(boolean noSince)`
`void` | `setNoTimestamp(boolean noTimestamp)`
`void` | `setNoTree(boolean noTree)`
`void` | `setSerialWarn(boolean serialWarn)`
`void` | `setSplitIndex(boolean splitIndex)`
`void` | `setStylesheetFile(File stylesheetFile)`
`void` | `setTagletPath(List tagletPath)`
`void` | `setTaglets(List taglets)`
`void` | `setTags(List tags)`
`void` | `setUse(boolean use)`
`void` | `setVersion(boolean version)`
`void` | `setWindowTitle(String windowTitle)`
`StandardJavadocDocletOptions` | `splitIndex(boolean splitIndex)`
`StandardJavadocDocletOptions` | `splitIndex()`
`StandardJavadocDocletOptions` | `stylesheetFile(File stylesheetFile)`
`StandardJavadocDocletOptions` | `tagletPath(List tagletPath)`
`StandardJavadocDocletOptions` | `tagletPath(File... tagletPath)`
`StandardJavadocDocletOptions` | `taglets(List taglets)`
`StandardJavadocDocletOptions` | `taglets(String... taglets)`
`StandardJavadocDocletOptions` | `tags(List tags)`
`StandardJavadocDocletOptions` | `tags(String... tags)`
`StandardJavadocDocletOptions` | `tagsFile(File tagsFile)`
`StandardJavadocDocletOptions` | `use(boolean use)`
`StandardJavadocDocletOptions` | `use()`
`StandardJavadocDocletOptions` | `version(boolean version)`
`StandardJavadocDocletOptions` | `version()`
`StandardJavadocDocletOptions` | `windowTitle(String windowTitle)`

Methods inherited from class 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

Field Detail

### noTimestamp

    public final JavadocOptionFileOption noTimestamp

Constructor Detail

### StandardJavadocDocletOptions

    public StandardJavadocDocletOptions()

### StandardJavadocDocletOptions

    public StandardJavadocDocletOptions(JavadocOptionFile javadocOptionFile)

Method Detail

### author

    public StandardJavadocDocletOptions author(boolean author)

### author

    public StandardJavadocDocletOptions author()

### bottom

    public StandardJavadocDocletOptions bottom(String bottom)

### charSet

    public StandardJavadocDocletOptions charSet(String charSet)

### destinationDirectory

    public StandardJavadocDocletOptions destinationDirectory(File destinationDirectory)

### docEncoding

    public StandardJavadocDocletOptions docEncoding(String docEncoding)

### docFilesSubDirs

    public StandardJavadocDocletOptions docFilesSubDirs(boolean docFilesSubDirs)

### docFilesSubDirs

    public StandardJavadocDocletOptions docFilesSubDirs()

### docTitle

    public StandardJavadocDocletOptions docTitle(String docTitle)

### excludeDocFilesSubDir

    public StandardJavadocDocletOptions excludeDocFilesSubDir(List excludeDocFilesSubDir)

### excludeDocFilesSubDir

    public StandardJavadocDocletOptions excludeDocFilesSubDir(String... excludeDocFilesSubDir)

### footer

    public StandardJavadocDocletOptions footer(String footer)

### getBottom

    public String getBottom()

### getCharSet

    public String getCharSet()

### getDestinationDirectory

    public File getDestinationDirectory()

### getDocEncoding

    public String getDocEncoding()

### getDocTitle

    public String getDocTitle()

### getExcludeDocFilesSubDir

    public List getExcludeDocFilesSubDir()

### getFooter

    public String getFooter()

### getGroups

    public Map getGroups()

### getHeader

    public String getHeader()

### getHelpFile

    public File getHelpFile()

### getLinks

    public List getLinks()

### getLinksOffline

    public List getLinksOffline()

### getNoQualifiers

    public List getNoQualifiers()

### getStylesheetFile

    public File getStylesheetFile()

### getTagletPath

    public List getTagletPath()

### getTaglets

    public List getTaglets()

### getTags

    public List getTags()

### getWindowTitle

    public String getWindowTitle()

### group

    public StandardJavadocDocletOptions group(Map groups)

### group

    public StandardJavadocDocletOptions group(String groupName, List packagePatterns)

### group

    public StandardJavadocDocletOptions group(String groupName, String... packagePatterns)

### groupsFile

    public StandardJavadocDocletOptions groupsFile(File groupsFile)

### header

    public StandardJavadocDocletOptions header(String header)

### helpFile

    public StandardJavadocDocletOptions helpFile(File helpFile)

### isAuthor

    public boolean isAuthor()

### isDocFilesSubDirs

    public boolean isDocFilesSubDirs()

### isKeyWords

    public boolean isKeyWords()

### isLinkSource

    public boolean isLinkSource()

### isNoComment

    public boolean isNoComment()

### isNoDeprecated

    public boolean isNoDeprecated()

### isNoDeprecatedList

    public boolean isNoDeprecatedList()

### isNoHelp

    public boolean isNoHelp()

### isNoIndex

    public boolean isNoIndex()

### isNoNavBar

    public boolean isNoNavBar()

### isNoSince

    public boolean isNoSince()

### isNoTimestamp

    public boolean isNoTimestamp()

### isNoTree

    public boolean isNoTree()

### isSerialWarn

    public boolean isSerialWarn()

### isSplitIndex

    public boolean isSplitIndex()

### isUse

    public boolean isUse()

### isVersion

    public boolean isVersion()

### keyWords

    public StandardJavadocDocletOptions keyWords(boolean keyWords)

### keyWords

    public StandardJavadocDocletOptions keyWords()

### linkSource

    public StandardJavadocDocletOptions linkSource(boolean linkSource)

### linkSource

    public StandardJavadocDocletOptions linkSource()

### links

    public StandardJavadocDocletOptions links(String... links)

### linksFile

    public StandardJavadocDocletOptions linksFile(File linksFile)

### linksOffline

    public StandardJavadocDocletOptions linksOffline(String extDocUrl, String packageListLoc)

### linksOfflineFile

    public StandardJavadocDocletOptions linksOfflineFile(File linksOfflineFile)

### noComment

    public StandardJavadocDocletOptions noComment(boolean noComment)

### noComment

    public StandardJavadocDocletOptions noComment()

### noDeprecated

    public StandardJavadocDocletOptions noDeprecated(boolean nodeprecated)

### noDeprecated

    public StandardJavadocDocletOptions noDeprecated()

### noDeprecatedList

    public StandardJavadocDocletOptions noDeprecatedList(boolean noDeprecatedList)

### noDeprecatedList

    public StandardJavadocDocletOptions noDeprecatedList()

### noHelp

    public StandardJavadocDocletOptions noHelp(boolean noHelp)

### noHelp

    public StandardJavadocDocletOptions noHelp()

### noIndex

    public StandardJavadocDocletOptions noIndex(boolean noIndex)

### noIndex

    public StandardJavadocDocletOptions noIndex()

### noNavBar

    public StandardJavadocDocletOptions noNavBar(boolean noNavBar)

### noNavBar

    public StandardJavadocDocletOptions noNavBar()

### noQualifier

    public StandardJavadocDocletOptions noQualifier(List noQualifiers)

### noQualifiers

    public StandardJavadocDocletOptions noQualifiers(String... noQualifiers)

### noSince

    public StandardJavadocDocletOptions noSince(boolean noSince)

### noSince

    public StandardJavadocDocletOptions noSince()

### noTimestamp

    public StandardJavadocDocletOptions noTimestamp(boolean noTimestamp)

### noTimestamp

    public StandardJavadocDocletOptions noTimestamp()

### noTree

    public StandardJavadocDocletOptions noTree(boolean noTree)

### noTree

    public StandardJavadocDocletOptions noTree()

### serialWarn

    public StandardJavadocDocletOptions serialWarn(boolean serialWarn)

### serialWarn

    public StandardJavadocDocletOptions serialWarn()

### setAuthor

    public void setAuthor(boolean author)

### setBottom

    public void setBottom(String bottom)

### setCharSet

    public void setCharSet(String charSet)

### setDestinationDirectory

    public void setDestinationDirectory(File directory)

### setDocEncoding

    public void setDocEncoding(String docEncoding)

### setDocFilesSubDirs

    public void setDocFilesSubDirs(boolean docFilesSubDirs)

### setDocTitle

    public void setDocTitle(String docTitle)

### setExcludeDocFilesSubDir

    public void setExcludeDocFilesSubDir(List excludeDocFilesSubDir)

### setFooter

    public void setFooter(String footer)

### setGroups

    public void setGroups(Map groups)

### setHeader

    public void setHeader(String header)

### setHelpFile

    public void setHelpFile(File helpFile)

### setKeyWords

    public void setKeyWords(boolean keyWords)

### setLinkSource

    public void setLinkSource(boolean linkSource)

### setLinks

    public void setLinks(List links)

### setLinksOffline

    public void setLinksOffline(List linksOffline)

### setNoComment

    public void setNoComment(boolean noComment)

### setNoDeprecated

    public void setNoDeprecated(boolean noDeprecated)

### setNoDeprecatedList

    public void setNoDeprecatedList(boolean noDeprecatedList)

### setNoHelp

    public void setNoHelp(boolean noHelp)

### setNoIndex

    public void setNoIndex(boolean noIndex)

### setNoNavBar

    public void setNoNavBar(boolean noNavBar)

### setNoQualifiers

    public void setNoQualifiers(List noQualifiers)

### setNoSince

    public void setNoSince(boolean noSince)

### setNoTimestamp

    public void setNoTimestamp(boolean noTimestamp)

### setNoTree

    public void setNoTree(boolean noTree)

### setSerialWarn

    public void setSerialWarn(boolean serialWarn)

### setSplitIndex

    public void setSplitIndex(boolean splitIndex)

### setStylesheetFile

    public void setStylesheetFile(File stylesheetFile)

### setTagletPath

    public void setTagletPath(List tagletPath)

### setTaglets

    public void setTaglets(List taglets)

### setTags

    public void setTags(List tags)

### setUse

    public void setUse(boolean use)

### setVersion

    public void setVersion(boolean version)

### setWindowTitle

    public void setWindowTitle(String windowTitle)

### splitIndex

    public StandardJavadocDocletOptions splitIndex(boolean splitIndex)

### splitIndex

    public StandardJavadocDocletOptions splitIndex()

### stylesheetFile

    public StandardJavadocDocletOptions stylesheetFile(File stylesheetFile)

### tagletPath

    public StandardJavadocDocletOptions tagletPath(List tagletPath)

### tagletPath

    public StandardJavadocDocletOptions tagletPath(File... tagletPath)

### taglets

    public StandardJavadocDocletOptions taglets(List taglets)

### taglets

    public StandardJavadocDocletOptions taglets(String... taglets)

### tags

    public StandardJavadocDocletOptions tags(List tags)

### tags

    public StandardJavadocDocletOptions tags(String... tags)

### tagsFile

    public StandardJavadocDocletOptions tagsFile(File tagsFile)

### use

    public StandardJavadocDocletOptions use(boolean use)

### use

    public StandardJavadocDocletOptions use()

### version

    public StandardJavadocDocletOptions version(boolean version)

### version

    public StandardJavadocDocletOptions version()

### windowTitle

    public StandardJavadocDocletOptions windowTitle(String windowTitle)

Gradle API 1.1-rc-1