Package org.gradle.external.javadoc

Interface MinimalJavadocOptions

All Known Implementing Classes:

CoreJavadocOptions, StandardJavadocDocletOptions

public interface MinimalJavadocOptions

Provides the core Javadoc options.

Method Summary

Modifier and Type	Method	Description
MinimalJavadocOptions	bootClasspath(File... bootClasspath)
MinimalJavadocOptions	breakIterator()
MinimalJavadocOptions	breakIterator(boolean breakIterator)
MinimalJavadocOptions	classpath(File... classpath)
MinimalJavadocOptions	classpath(List<File> classpath)
void	contributeCommandLineOptions(ExecSpec execHandleBuilder)
MinimalJavadocOptions	destinationDirectory(File directory)
MinimalJavadocOptions	doclet(String docletClass)
MinimalJavadocOptions	docletpath(File... docletpath)
MinimalJavadocOptions	encoding(String encoding)
MinimalJavadocOptions	extDirs(File... extDirs)
ConfigurableFileCollection	getBootClasspath()
Property<Boolean>	getBreakIterator()
ConfigurableFileCollection	getClasspath()
DirectoryProperty	getDestinationDirectory()
Property<String>	getDoclet()
ConfigurableFileCollection	getDocletpath()
Property<String>	getEncoding()
ConfigurableFileCollection	getExtDirs()
Property<String>	getHeader()
Property<Boolean>	getIsBreakIterator()	This method exists only for Kotlin source backward compatibility.
Provider<Boolean>	getIsVerbose()	This method exists only for Kotlin source backward compatibility.
ListProperty<String>	getJFlags()
Property<String>	getLocale()
Property<JavadocMemberLevel>	getMemberLevel()
ConfigurableFileCollection	getModulePath()	The --module-path.
ConfigurableFileCollection	getOptionFiles()
Property<JavadocOutputLevel>	getOutputLevel()
Property<String>	getOverview()
Property<String>	getSource()
ListProperty<String>	getSourceNames()
Provider<Boolean>	getVerbose()
Property<String>	getWindowTitle()
StandardJavadocDocletOptions	header(String header)
MinimalJavadocOptions	jFlags(String... jFlags)
MinimalJavadocOptions	locale(String locale)
MinimalJavadocOptions	modulePath(List<File> classpath)	The --module-path.
MinimalJavadocOptions	optionFiles(File... argumentFiles)
MinimalJavadocOptions	overview(String overview)
MinimalJavadocOptions	quiet()
MinimalJavadocOptions	showAll()
MinimalJavadocOptions	showFromPackage()
MinimalJavadocOptions	showFromPrivate()
MinimalJavadocOptions	showFromProtected()
MinimalJavadocOptions	showFromPublic()
MinimalJavadocOptions	source(String source)
MinimalJavadocOptions	sourceNames(String... sourceNames)
MinimalJavadocOptions	verbose()
StandardJavadocDocletOptions	windowTitle(String windowTitle)
void	write(File outputFile)

Method Details

getOverview

@Input
@Optional
Property<String> getOverview()

overview

MinimalJavadocOptions overview(String overview)

getMemberLevel

@Input
@Optional
Property<JavadocMemberLevel> getMemberLevel()

showFromPublic

MinimalJavadocOptions showFromPublic()

showFromProtected

MinimalJavadocOptions showFromProtected()

showFromPackage

MinimalJavadocOptions showFromPackage()

showFromPrivate

MinimalJavadocOptions showFromPrivate()

showAll

MinimalJavadocOptions showAll()

getDoclet

@Input
@Optional
Property<String> getDoclet()

doclet

MinimalJavadocOptions doclet(String docletClass)

getDocletpath

@Classpath
ConfigurableFileCollection getDocletpath()

docletpath

MinimalJavadocOptions docletpath(File... docletpath)

getSource

@Input
@Optional
Property<String> getSource()

source

MinimalJavadocOptions source(String source)

getClasspath

@Internal
ConfigurableFileCollection getClasspath()

getModulePath

@Internal
ConfigurableFileCollection getModulePath()

The --module-path.

Since:

6.4

modulePath

MinimalJavadocOptions modulePath(List<File> classpath)

The --module-path.

Since:

6.4

classpath

MinimalJavadocOptions classpath(List<File> classpath)

classpath

MinimalJavadocOptions classpath(File... classpath)

getBootClasspath

@Classpath
ConfigurableFileCollection getBootClasspath()

bootClasspath

MinimalJavadocOptions bootClasspath(File... bootClasspath)

getExtDirs

@InputFiles
@Optional
@IgnoreEmptyDirectories
@PathSensitive(RELATIVE)
ConfigurableFileCollection getExtDirs()

extDirs

MinimalJavadocOptions extDirs(File... extDirs)

getOutputLevel

@Console
Property<JavadocOutputLevel> getOutputLevel()

verbose

MinimalJavadocOptions verbose()

getVerbose

@Internal
Provider<Boolean> getVerbose()

getIsVerbose

@Internal
Provider<Boolean> getIsVerbose()

This method exists only for Kotlin source backward compatibility.

quiet

MinimalJavadocOptions quiet()

getBreakIterator

@Input
Property<Boolean> getBreakIterator()

getIsBreakIterator

@Internal
Property<Boolean> getIsBreakIterator()

This method exists only for Kotlin source backward compatibility.

breakIterator

MinimalJavadocOptions breakIterator(boolean breakIterator)

breakIterator

MinimalJavadocOptions breakIterator()

getLocale

@Input
@Optional
Property<String> getLocale()

locale

MinimalJavadocOptions locale(String locale)

getEncoding

@Input
@Optional
Property<String> getEncoding()

encoding

MinimalJavadocOptions encoding(String encoding)

getJFlags

@Input
@Optional
ListProperty<String> getJFlags()

jFlags

MinimalJavadocOptions jFlags(String... jFlags)

getOptionFiles

@InputFiles
@Optional
@PathSensitive(NONE)
ConfigurableFileCollection getOptionFiles()

optionFiles

MinimalJavadocOptions optionFiles(File... argumentFiles)

getDestinationDirectory

@Internal
DirectoryProperty getDestinationDirectory()

destinationDirectory

MinimalJavadocOptions destinationDirectory(File directory)

getWindowTitle

@Input
@Optional
Property<String> getWindowTitle()

windowTitle

StandardJavadocDocletOptions windowTitle(String windowTitle)

getHeader

@Input
@Optional
Property<String> getHeader()

header

StandardJavadocDocletOptions header(String header)

write

void write(File outputFile)
    throws IOException

Throws:

IOException

getSourceNames

@Internal
ListProperty<String> getSourceNames()

sourceNames

MinimalJavadocOptions sourceNames(String... sourceNames)

contributeCommandLineOptions

void contributeCommandLineOptions(ExecSpec execHandleBuilder)