ExtStandardJavadocDocletOptions (kordamp-gradle-plugins unspecified)

org.kordamp.gradle.plugin.base.model.impl.ExtStandardJavadocDocletOptions

@CompileStatic
class ExtStandardJavadocDocletOptions
extends StandardJavadocDocletOptions

Authors:: Andres Almiray

Since:: 0.4.0

Inherited fields
Fields inherited from class	Fields
`class StandardJavadocDocletOptions`	`noTimestamp`

Constructor Summary

Constructors
Constructor and description
`ExtStandardJavadocDocletOptions ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`JavadocOptionFileOption<Boolean>`	`addBooleanOption(String option)`
	`JavadocOptionFileOption<Boolean>`	`addBooleanOption(String option, boolean value)`
`<T extends Enum<T>>`	`JavadocOptionFileOption<T>`	`addEnumOption(String option)`
`<T extends Enum<T>>`	`JavadocOptionFileOption<T>`	`addEnumOption(String option, T value)`
	`JavadocOptionFileOption<File>`	`addFileOption(String option)`
	`JavadocOptionFileOption<File>`	`addFileOption(String option, File value)`
	`JavadocOptionFileOption<List<List<String>>>`	`addMultilineMultiValueOption(String option)`
	`JavadocOptionFileOption<List<String>>`	`addMultilineStringsOption(String option)`
`<T>`	`JavadocOptionFileOption<T>`	`addOption(JavadocOptionFileOption<T> option)`
	`JavadocOptionFileOption<List<File>>`	`addPathOption(String option)`
	`JavadocOptionFileOption<List<File>>`	`addPathOption(String option, String joinBy)`
	`JavadocOptionFileOption<String>`	`addStringOption(String option)`
	`JavadocOptionFileOption<String>`	`addStringOption(String option, String value)`
	`JavadocOptionFileOption<List<String>>`	`addStringsOption(String option)`
	`JavadocOptionFileOption<List<String>>`	`addStringsOption(String option, String joinBy)`
	`void`	`applyTo(MinimalJavadocOptions options)`
	`MinimalJavadocOptions`	`breakIterator(boolean breakIterator)`
	`boolean`	`isAuthorSet()`
	`boolean`	`isBreakIteratorSet()`
	`boolean`	`isDocFilesSubDirsSet()`
	`boolean`	`isKewWordsSet()`
	`boolean`	`isLinkSourceSet()`
	`boolean`	`isNoCommentSet()`
	`boolean`	`isNoHelpSet()`
	`boolean`	`isNoIndexSet()`
	`boolean`	`isNoNavBarSet()`
	`boolean`	`isNoSinceSet()`
	`boolean`	`isNoTimestampSet()`
	`boolean`	`isNoTreeSet()`
	`boolean`	`isSerialWarnSet()`
	`boolean`	`isSplitIndexSet()`
	`boolean`	`isUseSet()`
	`boolean`	`isVersionSet()`
	`StandardJavadocDocletOptions`	`keyWords(boolean keyWords)`
`<T>`	`static List<T>`	`list(List<T> src)`
`<T>`	`static List<T>`	`list(List<T> l1, List<T> l2)`
`<K, V>`	`static Map<K, V>`	`map(Map<K, V> src)`
`<K, V>`	`static Map<K, V>`	`map(Map<K, V> m1, Map<K, V> m2)`
	`static void`	`merge(ExtStandardJavadocDocletOptions o1, ExtStandardJavadocDocletOptions o2)`
	`StandardJavadocDocletOptions`	`noComment(boolean noComment)`
	`StandardJavadocDocletOptions`	`noHelp(boolean noHelp)`
	`StandardJavadocDocletOptions`	`noIndex(boolean noIndex)`
	`StandardJavadocDocletOptions`	`noNavBar(boolean noNavBar)`
	`StandardJavadocDocletOptions`	`noSince(boolean noSince)`
	`StandardJavadocDocletOptions`	`noTimestamp(boolean noTimestamp)`
	`StandardJavadocDocletOptions`	`noTree(boolean noTree)`
	`StandardJavadocDocletOptions`	`serialWarn(boolean serialWarn)`
	`void`	`setAuthor(boolean author)`
	`void`	`setBreakIterator(boolean breakIterator)`
	`void`	`setDocFilesSubDirs(boolean docFilesSubDirs)`
	`void`	`setKeyWords(boolean keyWords)`
	`void`	`setLinkSource(boolean linkSource)`
	`void`	`setNoComment(boolean noComment)`
	`void`	`setNoHelp(boolean noHelp)`
	`void`	`setNoIndex(boolean noIndex)`
	`void`	`setNoNavBar(boolean noNavBar)`
	`void`	`setNoSince(boolean noSince)`
	`void`	`setNoTimestamp(boolean noTimestamp)`
	`void`	`setNoTree(boolean noTree)`
	`void`	`setSerialWarn(boolean serialWarn)`
	`void`	`setSplitIndex(boolean splitIndex)`
	`void`	`setUse(boolean use)`
	`void`	`setVersion(boolean version)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class StandardJavadocDocletOptions`	group, group, group, version, version, header, bottom, tags, tags, getHeader, setHeader, getGroups, isVersion, setVersion, links, use, use, getDestinationDirectory, destinationDirectory, destinationDirectory, linksOffline, noDeprecated, noDeprecated, noDeprecatedList, noDeprecatedList, stylesheetFile, docEncoding, excludeDocFilesSubDir, excludeDocFilesSubDir, noQualifiers, knownOptionNames, linksOfflineFile, isNoDeprecated, setNoDeprecated, isNoDeprecatedList, setNoDeprecatedList, noQualifier, setWindowTitle, setDocTitle, windowTitle, getWindowTitle, getDocTitle, noTimestamp, noTimestamp, setNoTimestamp, isNoTimestamp, setLinkSource, setNoNavBar, setSerialWarn, setKeyWords, setNoComment, setDocFilesSubDirs, docFilesSubDirs, docFilesSubDirs, isDocFilesSubDirs, isLinkSource, isNoComment, isSerialWarn, setDestinationDirectory, getDocEncoding, setDocEncoding, getExcludeDocFilesSubDir, setExcludeDocFilesSubDir, getHelpFile, setHelpFile, getLinksOffline, setLinksOffline, getNoQualifiers, setNoQualifiers, getStylesheetFile, setStylesheetFile, getTagletPath, setTagletPath, setSplitIndex, isSplitIndex, setUse, docTitle, getFooter, setFooter, setLinks, linkSource, linkSource, setNoSince, noSince, noSince, setNoTree, noTree, noTree, setNoIndex, noIndex, noIndex, setNoHelp, noHelp, noHelp, noNavBar, noNavBar, serialWarn, serialWarn, keyWords, keyWords, noComment, noComment, isKeyWords, isNoHelp, isNoIndex, isNoNavBar, isNoSince, isNoTree, getBottom, setBottom, getCharSet, setCharSet, setGroups, setAuthor, author, author, isAuthor, splitIndex, splitIndex, isUse, getTags, setTags, helpFile, charSet, taglets, taglets, tagletPath, tagletPath, linksFile, groupsFile, tagsFile, setTaglets, getTaglets, getLinks, footer, locale, source, write, encoding, getEncoding, getSource, verbose, isVerbose, setEncoding, getLocale, setLocale, quiet, classpath, classpath, setClasspath, getClasspath, getModulePath, optionFiles, showFromPublic, showFromProtected, showFromPackage, showFromPrivate, setModulePath, bootClasspath, sourceNames, addStringOption, addStringOption, addEnumOption, addEnumOption, addPathOption, addPathOption, addStringsOption, addStringsOption, addMultilineStringsOption, addBooleanOption, addBooleanOption, addFileOption, addFileOption, setBreakIterator, breakIterator, breakIterator, isBreakIterator, getBootClasspath, setBootClasspath, getDocletpath, setDocletpath, getMemberLevel, setMemberLevel, getOptionFiles, setOptionFiles, getOutputLevel, setOutputLevel, getOverview, setOverview, getSourceNames, setSourceNames, addMultilineMultiValueOption, contributeCommandLineOptions, overview, addOption, getDoclet, setDoclet, getExtDirs, setExtDirs, getJFlags, setJFlags, modulePath, showAll, doclet, docletpath, extDirs, jFlags, setSource, wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll

- Constructor Detail
  - ExtStandardJavadocDocletOptions()
- Method Detail
  - JavadocOptionFileOption<Boolean> addBooleanOption(String option)
  - JavadocOptionFileOption<Boolean> addBooleanOption(String option, boolean value)
  - <T extends Enum<T>> JavadocOptionFileOption<T> addEnumOption(String option)
  - <T extends Enum<T>> JavadocOptionFileOption<T> addEnumOption(String option, T value)
  - JavadocOptionFileOption<File> addFileOption(String option)
  - JavadocOptionFileOption<File> addFileOption(String option, File value)
  - JavadocOptionFileOption<List<List<String>>> addMultilineMultiValueOption(String option)
  - JavadocOptionFileOption<List<String>> addMultilineStringsOption(String option)
  - <T> JavadocOptionFileOption<T> addOption(JavadocOptionFileOption<T> option)
  - JavadocOptionFileOption<List<File>> addPathOption(String option)
  - JavadocOptionFileOption<List<File>> addPathOption(String option, String joinBy)
  - JavadocOptionFileOption<String> addStringOption(String option)
  - JavadocOptionFileOption<String> addStringOption(String option, String value)
  - JavadocOptionFileOption<List<String>> addStringsOption(String option)
  - JavadocOptionFileOption<List<String>> addStringsOption(String option, String joinBy)
  - void applyTo(MinimalJavadocOptions options)
  - @Override MinimalJavadocOptions breakIterator(boolean breakIterator)
  - boolean isAuthorSet()
  - boolean isBreakIteratorSet()
  - boolean isDocFilesSubDirsSet()
  - boolean isKewWordsSet()
  - boolean isLinkSourceSet()
  - boolean isNoCommentSet()
  - boolean isNoHelpSet()
  - boolean isNoIndexSet()
  - boolean isNoNavBarSet()
  - boolean isNoSinceSet()
  - boolean isNoTimestampSet()
  - boolean isNoTreeSet()
  - boolean isSerialWarnSet()
  - boolean isSplitIndexSet()
  - boolean isUseSet()
  - boolean isVersionSet()
  - @Override StandardJavadocDocletOptions keyWords(boolean keyWords)
  - <T> @CompileDynamic static List<T> list(List<T> src)
  - <T> @CompileDynamic static List<T> list(List<T> l1, List<T> l2)
  - <K, V> static Map<K, V> map(Map<K, V> src)
  - <K, V> static Map<K, V> map(Map<K, V> m1, Map<K, V> m2)
  - static void merge(ExtStandardJavadocDocletOptions o1, ExtStandardJavadocDocletOptions o2)
  - @Override StandardJavadocDocletOptions noComment(boolean noComment)
  - @Override StandardJavadocDocletOptions noHelp(boolean noHelp)
  - @Override StandardJavadocDocletOptions noIndex(boolean noIndex)
  - @Override StandardJavadocDocletOptions noNavBar(boolean noNavBar)
  - @Override StandardJavadocDocletOptions noSince(boolean noSince)
  - @Override StandardJavadocDocletOptions noTimestamp(boolean noTimestamp)
  - @Override StandardJavadocDocletOptions noTree(boolean noTree)
  - @Override StandardJavadocDocletOptions serialWarn(boolean serialWarn)
  - @Override void setAuthor(boolean author)
  - @Override void setBreakIterator(boolean breakIterator)
  - @Override void setDocFilesSubDirs(boolean docFilesSubDirs)
  - @Override void setKeyWords(boolean keyWords)
  - @Override void setLinkSource(boolean linkSource)
  - @Override void setNoComment(boolean noComment)
  - @Override void setNoHelp(boolean noHelp)
  - @Override void setNoIndex(boolean noIndex)
  - @Override void setNoNavBar(boolean noNavBar)
  - @Override void setNoSince(boolean noSince)
  - @Override void setNoTimestamp(boolean noTimestamp)
  - @Override void setNoTree(boolean noTree)
  - @Override void setSerialWarn(boolean serialWarn)
  - @Override void setSplitIndex(boolean splitIndex)
  - @Override void setUse(boolean use)
  - @Override void setVersion(boolean version)

Summary:
Constructor
Method

| Detail:
Constructor
Method

Groovy Documentation

[Groovy] Class ExtStandardJavadocDocletOptions

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

ExtStandardJavadocDocletOptions()

Method Detail

JavadocOptionFileOption<Boolean> addBooleanOption(String option)

JavadocOptionFileOption<Boolean> addBooleanOption(String option, boolean value)

<T extends Enum<T>> JavadocOptionFileOption<T> addEnumOption(String option)

<T extends Enum<T>> JavadocOptionFileOption<T> addEnumOption(String option, T value)

JavadocOptionFileOption<File> addFileOption(String option)

JavadocOptionFileOption<File> addFileOption(String option, File value)

JavadocOptionFileOption<List<List<String>>> addMultilineMultiValueOption(String option)

JavadocOptionFileOption<List<String>> addMultilineStringsOption(String option)

<T> JavadocOptionFileOption<T> addOption(JavadocOptionFileOption<T> option)

JavadocOptionFileOption<List<File>> addPathOption(String option)

JavadocOptionFileOption<List<File>> addPathOption(String option, String joinBy)

JavadocOptionFileOption<String> addStringOption(String option)

JavadocOptionFileOption<String> addStringOption(String option, String value)

JavadocOptionFileOption<List<String>> addStringsOption(String option)

JavadocOptionFileOption<List<String>> addStringsOption(String option, String joinBy)

void applyTo(MinimalJavadocOptions options)

@Override MinimalJavadocOptions breakIterator(boolean breakIterator)

boolean isAuthorSet()

boolean isBreakIteratorSet()

boolean isDocFilesSubDirsSet()

boolean isKewWordsSet()

boolean isLinkSourceSet()

boolean isNoCommentSet()

boolean isNoHelpSet()

boolean isNoIndexSet()

boolean isNoNavBarSet()

boolean isNoSinceSet()

boolean isNoTimestampSet()

boolean isNoTreeSet()

boolean isSerialWarnSet()

boolean isSplitIndexSet()

boolean isUseSet()

boolean isVersionSet()

@Override StandardJavadocDocletOptions keyWords(boolean keyWords)

<T> @CompileDynamic static List<T> list(List<T> src)

<T> @CompileDynamic static List<T> list(List<T> l1, List<T> l2)

<K, V> static Map<K, V> map(Map<K, V> src)

<K, V> static Map<K, V> map(Map<K, V> m1, Map<K, V> m2)

static void merge(ExtStandardJavadocDocletOptions o1, ExtStandardJavadocDocletOptions o2)

@Override StandardJavadocDocletOptions noComment(boolean noComment)

@Override StandardJavadocDocletOptions noHelp(boolean noHelp)

@Override StandardJavadocDocletOptions noIndex(boolean noIndex)

@Override StandardJavadocDocletOptions noNavBar(boolean noNavBar)

@Override StandardJavadocDocletOptions noSince(boolean noSince)

@Override StandardJavadocDocletOptions noTimestamp(boolean noTimestamp)

@Override StandardJavadocDocletOptions noTree(boolean noTree)

@Override StandardJavadocDocletOptions serialWarn(boolean serialWarn)

@Override void setAuthor(boolean author)

@Override void setBreakIterator(boolean breakIterator)

@Override void setDocFilesSubDirs(boolean docFilesSubDirs)

@Override void setKeyWords(boolean keyWords)

@Override void setLinkSource(boolean linkSource)

@Override void setNoComment(boolean noComment)

@Override void setNoHelp(boolean noHelp)

@Override void setNoIndex(boolean noIndex)

@Override void setNoNavBar(boolean noNavBar)

@Override void setNoSince(boolean noSince)

@Override void setNoTimestamp(boolean noTimestamp)

@Override void setNoTree(boolean noTree)

@Override void setSerialWarn(boolean serialWarn)

@Override void setSplitIndex(boolean splitIndex)

@Override void setUse(boolean use)

@Override void setVersion(boolean version)