Groovy Documentation

org.gradle.external.javadoc
[Java] Interface MinimalJavadocOptions


public interface MinimalJavadocOptions

Provides the core Javadoc options.


Method Summary
MinimalJavadocOptions bootClasspath(File... bootClasspath)

MinimalJavadocOptions breakIterator(boolean breakIterator)

MinimalJavadocOptions breakIterator()

MinimalJavadocOptions classpath(List classpath)

MinimalJavadocOptions classpath(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)

List getBootClasspath()

List getClasspath()

File getDestinationDirectory()

String getDoclet()

List getDocletpath()

String getEncoding()

List getExtDirs()

String getHeader()

List getJFlags()

String getLocale()

JavadocMemberLevel getMemberLevel()

List getOptionFiles()

JavadocOutputLevel getOutputLevel()

String getOverview()

String getSource()

List getSourceNames()

String getWindowTitle()

StandardJavadocDocletOptions header(String header)

boolean isBreakIterator()

boolean isVerbose()

MinimalJavadocOptions jFlags(String... jFlags)

MinimalJavadocOptions locale(String locale)

MinimalJavadocOptions optionFiles(File... argumentFiles)

MinimalJavadocOptions overview(String overview)

MinimalJavadocOptions quiet()

void setBootClasspath(List bootClasspath)

void setBreakIterator(boolean breakIterator)

void setClasspath(List classpath)

void setDestinationDirectory(File directory)

void setDoclet(String docletClass)

void setDocletpath(List docletpath)

void setEncoding(String encoding)

void setExtDirs(List extDirs)

void setHeader(String header)

void setJFlags(List jFlags)

void setLocale(String locale)

void setMemberLevel(JavadocMemberLevel memberLevel)

void setOptionFiles(List optionFiles)

void setOutputLevel(JavadocOutputLevel outputLevel)

void setOverview(String overview)

void setSource(String source)

void setSourceNames(List sourceNames)

void setWindowTitle(String windowTitle)

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 Detail

bootClasspath

public MinimalJavadocOptions bootClasspath(File... bootClasspath)


breakIterator

public MinimalJavadocOptions breakIterator(boolean breakIterator)


breakIterator

public MinimalJavadocOptions breakIterator()


classpath

public MinimalJavadocOptions classpath(List classpath)


classpath

public MinimalJavadocOptions classpath(File... classpath)


contributeCommandLineOptions

public void contributeCommandLineOptions(ExecSpec execHandleBuilder)


destinationDirectory

public MinimalJavadocOptions destinationDirectory(File directory)


doclet

public MinimalJavadocOptions doclet(String docletClass)


docletpath

public MinimalJavadocOptions docletpath(File... docletpath)


encoding

public MinimalJavadocOptions encoding(String encoding)


extDirs

public MinimalJavadocOptions extDirs(File... extDirs)


getBootClasspath

@InputFiles
public List getBootClasspath()


getClasspath

public List getClasspath()


getDestinationDirectory

public File getDestinationDirectory()


getDoclet

@Input
@Optional
public String getDoclet()


getDocletpath

@InputFiles
public List getDocletpath()


getEncoding

@Input
@Optional
public String getEncoding()


getExtDirs

@InputFiles
public List getExtDirs()


getHeader

@Input
@Optional
public String getHeader()


getJFlags

public List getJFlags()


getLocale

@Input
@Optional
public String getLocale()


getMemberLevel

@Input
@Optional
public JavadocMemberLevel getMemberLevel()


getOptionFiles

public List getOptionFiles()


getOutputLevel

public JavadocOutputLevel getOutputLevel()


getOverview

@Input
@Optional
public String getOverview()


getSource

@Input
@Optional
public String getSource()


getSourceNames

public List getSourceNames()


getWindowTitle

@Input
@Optional
public String getWindowTitle()


header

public StandardJavadocDocletOptions header(String header)


isBreakIterator

@Input
public boolean isBreakIterator()


isVerbose

public boolean isVerbose()


jFlags

public MinimalJavadocOptions jFlags(String... jFlags)


locale

public MinimalJavadocOptions locale(String locale)


optionFiles

public MinimalJavadocOptions optionFiles(File... argumentFiles)


overview

public MinimalJavadocOptions overview(String overview)


quiet

public MinimalJavadocOptions quiet()


setBootClasspath

public void setBootClasspath(List bootClasspath)


setBreakIterator

public void setBreakIterator(boolean breakIterator)


setClasspath

public void setClasspath(List classpath)


setDestinationDirectory

public void setDestinationDirectory(File directory)


setDoclet

public void setDoclet(String docletClass)


setDocletpath

public void setDocletpath(List docletpath)


setEncoding

public void setEncoding(String encoding)


setExtDirs

public void setExtDirs(List extDirs)


setHeader

public void setHeader(String header)


setJFlags

public void setJFlags(List jFlags)


setLocale

public void setLocale(String locale)


setMemberLevel

public void setMemberLevel(JavadocMemberLevel memberLevel)


setOptionFiles

public void setOptionFiles(List optionFiles)


setOutputLevel

public void setOutputLevel(JavadocOutputLevel outputLevel)


setOverview

public void setOverview(String overview)


setSource

public void setSource(String source)


setSourceNames

public void setSourceNames(List sourceNames)


setWindowTitle

public void setWindowTitle(String windowTitle)


showAll

public MinimalJavadocOptions showAll()


showFromPackage

public MinimalJavadocOptions showFromPackage()


showFromPrivate

public MinimalJavadocOptions showFromPrivate()


showFromProtected

public MinimalJavadocOptions showFromProtected()


showFromPublic

public MinimalJavadocOptions showFromPublic()


source

public MinimalJavadocOptions source(String source)


sourceNames

public MinimalJavadocOptions sourceNames(String... sourceNames)


verbose

public MinimalJavadocOptions verbose()


windowTitle

public StandardJavadocDocletOptions windowTitle(String windowTitle)


write

public void write(File outputFile)


 

Gradle API 1.8