Package org.gradle.external.javadoc
Interface MinimalJavadocOptions
-
- All Known Implementing Classes:
CoreJavadocOptions,StandardJavadocDocletOptions
public interface MinimalJavadocOptionsProvides the core Javadoc options.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description MinimalJavadocOptionsbootClasspath(java.io.File... bootClasspath)MinimalJavadocOptionsbreakIterator()MinimalJavadocOptionsbreakIterator(boolean breakIterator)MinimalJavadocOptionsclasspath(java.io.File... classpath)MinimalJavadocOptionsclasspath(java.util.List<java.io.File> classpath)voidcontributeCommandLineOptions(ExecSpec execHandleBuilder)MinimalJavadocOptionsdestinationDirectory(java.io.File directory)MinimalJavadocOptionsdoclet(java.lang.String docletClass)MinimalJavadocOptionsdocletpath(java.io.File... docletpath)MinimalJavadocOptionsencoding(java.lang.String encoding)MinimalJavadocOptionsextDirs(java.io.File... extDirs)java.util.List<java.io.File>getBootClasspath()java.util.List<java.io.File>getClasspath()java.io.FilegetDestinationDirectory()java.lang.StringgetDoclet()java.util.List<java.io.File>getDocletpath()java.lang.StringgetEncoding()java.util.List<java.io.File>getExtDirs()java.lang.StringgetHeader()java.util.List<java.lang.String>getJFlags()java.lang.StringgetLocale()JavadocMemberLevelgetMemberLevel()java.util.List<java.io.File>getModulePath()The --module-path.java.util.List<java.io.File>getOptionFiles()JavadocOutputLevelgetOutputLevel()java.lang.StringgetOverview()java.lang.StringgetSource()java.util.List<java.lang.String>getSourceNames()java.lang.StringgetWindowTitle()StandardJavadocDocletOptionsheader(java.lang.String header)booleanisBreakIterator()booleanisVerbose()MinimalJavadocOptionsjFlags(java.lang.String... jFlags)MinimalJavadocOptionslocale(java.lang.String locale)MinimalJavadocOptionsmodulePath(java.util.List<java.io.File> classpath)The --module-path.MinimalJavadocOptionsoptionFiles(java.io.File... argumentFiles)MinimalJavadocOptionsoverview(java.lang.String overview)MinimalJavadocOptionsquiet()voidsetBootClasspath(java.util.List<java.io.File> bootClasspath)voidsetBreakIterator(boolean breakIterator)voidsetClasspath(java.util.List<java.io.File> classpath)voidsetDestinationDirectory(java.io.File directory)voidsetDoclet(java.lang.String docletClass)voidsetDocletpath(java.util.List<java.io.File> docletpath)voidsetEncoding(java.lang.String encoding)voidsetExtDirs(java.util.List<java.io.File> extDirs)voidsetHeader(java.lang.String header)voidsetJFlags(java.util.List<java.lang.String> jFlags)voidsetLocale(java.lang.String locale)voidsetMemberLevel(JavadocMemberLevel memberLevel)voidsetModulePath(java.util.List<java.io.File> modulePath)The --module-path.voidsetOptionFiles(java.util.List<java.io.File> optionFiles)voidsetOutputLevel(JavadocOutputLevel outputLevel)voidsetOverview(java.lang.String overview)voidsetSource(java.lang.String source)voidsetSourceNames(java.util.List<java.lang.String> sourceNames)voidsetWindowTitle(java.lang.String windowTitle)MinimalJavadocOptionsshowAll()MinimalJavadocOptionsshowFromPackage()MinimalJavadocOptionsshowFromPrivate()MinimalJavadocOptionsshowFromProtected()MinimalJavadocOptionsshowFromPublic()MinimalJavadocOptionssource(java.lang.String source)MinimalJavadocOptionssourceNames(java.lang.String... sourceNames)MinimalJavadocOptionsverbose()StandardJavadocDocletOptionswindowTitle(java.lang.String windowTitle)voidwrite(java.io.File outputFile)
-
-
-
Method Detail
-
setOverview
void setOverview(@Nullable java.lang.String overview)
-
overview
MinimalJavadocOptions overview(java.lang.String overview)
-
getMemberLevel
@Nullable @Optional @Input JavadocMemberLevel getMemberLevel()
-
setMemberLevel
void setMemberLevel(@Nullable JavadocMemberLevel memberLevel)
-
showFromPublic
MinimalJavadocOptions showFromPublic()
-
showFromProtected
MinimalJavadocOptions showFromProtected()
-
showFromPackage
MinimalJavadocOptions showFromPackage()
-
showFromPrivate
MinimalJavadocOptions showFromPrivate()
-
showAll
MinimalJavadocOptions showAll()
-
setDoclet
void setDoclet(@Nullable java.lang.String docletClass)
-
doclet
MinimalJavadocOptions doclet(java.lang.String docletClass)
-
getDocletpath
@Classpath java.util.List<java.io.File> getDocletpath()
-
setDocletpath
void setDocletpath(java.util.List<java.io.File> docletpath)
-
docletpath
MinimalJavadocOptions docletpath(java.io.File... docletpath)
-
setSource
void setSource(@Nullable java.lang.String source)
-
source
MinimalJavadocOptions source(java.lang.String source)
-
getClasspath
@Internal java.util.List<java.io.File> getClasspath()
-
setClasspath
void setClasspath(java.util.List<java.io.File> classpath)
-
getModulePath
@Internal java.util.List<java.io.File> getModulePath()
The --module-path.- Since:
- 6.4
-
setModulePath
void setModulePath(java.util.List<java.io.File> modulePath)
The --module-path.- Since:
- 6.4
-
modulePath
MinimalJavadocOptions modulePath(java.util.List<java.io.File> classpath)
The --module-path.- Since:
- 6.4
-
classpath
MinimalJavadocOptions classpath(java.util.List<java.io.File> classpath)
-
classpath
MinimalJavadocOptions classpath(java.io.File... classpath)
-
getBootClasspath
@Classpath java.util.List<java.io.File> getBootClasspath()
-
setBootClasspath
void setBootClasspath(java.util.List<java.io.File> bootClasspath)
-
bootClasspath
MinimalJavadocOptions bootClasspath(java.io.File... bootClasspath)
-
getExtDirs
@Nullable @Optional @IgnoreEmptyDirectories @PathSensitive(RELATIVE) @InputFiles java.util.List<java.io.File> getExtDirs()
-
setExtDirs
void setExtDirs(@Nullable java.util.List<java.io.File> extDirs)
-
extDirs
MinimalJavadocOptions extDirs(java.io.File... extDirs)
-
getOutputLevel
@Console JavadocOutputLevel getOutputLevel()
-
setOutputLevel
void setOutputLevel(JavadocOutputLevel outputLevel)
-
verbose
MinimalJavadocOptions verbose()
-
isVerbose
@Internal boolean isVerbose()
-
quiet
MinimalJavadocOptions quiet()
-
isBreakIterator
@Input boolean isBreakIterator()
-
setBreakIterator
void setBreakIterator(boolean breakIterator)
-
breakIterator
MinimalJavadocOptions breakIterator(boolean breakIterator)
-
breakIterator
MinimalJavadocOptions breakIterator()
-
setLocale
void setLocale(@Nullable java.lang.String locale)
-
locale
MinimalJavadocOptions locale(java.lang.String locale)
-
setEncoding
void setEncoding(@Nullable java.lang.String encoding)
-
encoding
MinimalJavadocOptions encoding(java.lang.String encoding)
-
setJFlags
void setJFlags(@Nullable java.util.List<java.lang.String> jFlags)
-
jFlags
MinimalJavadocOptions jFlags(java.lang.String... jFlags)
-
getOptionFiles
@Nullable @Optional @PathSensitive(NONE) @InputFiles java.util.List<java.io.File> getOptionFiles()
-
setOptionFiles
void setOptionFiles(@Nullable java.util.List<java.io.File> optionFiles)
-
optionFiles
MinimalJavadocOptions optionFiles(java.io.File... argumentFiles)
-
getDestinationDirectory
@Internal java.io.File getDestinationDirectory()
-
setDestinationDirectory
void setDestinationDirectory(@Nullable java.io.File directory)
-
destinationDirectory
MinimalJavadocOptions destinationDirectory(java.io.File directory)
-
setWindowTitle
void setWindowTitle(@Nullable java.lang.String windowTitle)
-
windowTitle
StandardJavadocDocletOptions windowTitle(java.lang.String windowTitle)
-
setHeader
void setHeader(@Nullable java.lang.String header)
-
header
StandardJavadocDocletOptions header(java.lang.String header)
-
write
void write(java.io.File outputFile) throws java.io.IOException- Throws:
java.io.IOException
-
getSourceNames
@Nullable @Internal java.util.List<java.lang.String> getSourceNames()
-
setSourceNames
void setSourceNames(@Nullable java.util.List<java.lang.String> sourceNames)
-
sourceNames
MinimalJavadocOptions sourceNames(java.lang.String... sourceNames)
-
contributeCommandLineOptions
void contributeCommandLineOptions(ExecSpec execHandleBuilder)
-
-