Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.gradle.external.javadoc
Interface MinimalJavadocOptions

All Known Implementing Classes:
CoreJavadocOptions, StandardJavadocDocletOptions
public interface MinimalJavadocOptions

Provides the core Javadoc options.

Method Summary
 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)
           
 List<File> getBootClasspath()
           
 List<File> getClasspath()
           
 File getDestinationDirectory()
           
 String getDoclet()
           
 List<File> getDocletpath()
           
 String getEncoding()
           
 List<File> getExtDirs()
           
 String getHeader()
           
 List<String> getJFlags()
           
 String getLocale()
           
 JavadocMemberLevel getMemberLevel()
           
 List<File> getOptionFiles()
           
 JavadocOutputLevel getOutputLevel()
           
 String getOverview()
           
 String getSource()
           
 List<String> 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<File> bootClasspath)
           
 void setBreakIterator(boolean breakIterator)
           
 void setClasspath(List<File> classpath)
           
 void setDestinationDirectory(File directory)
           
 void setDoclet(String docletClass)
           
 void setDocletpath(List<File> docletpath)
           
 void setEncoding(String encoding)
           
 void setExtDirs(List<File> extDirs)
           
 void setHeader(String header)
           
 void setJFlags(List<String> jFlags)
           
 void setLocale(String locale)
           
 void setMemberLevel(JavadocMemberLevel memberLevel)
           
 void setOptionFiles(List<File> optionFiles)
           
 void setOutputLevel(JavadocOutputLevel outputLevel)
           
 void setOverview(String overview)
           
 void setSource(String source)
           
 void setSourceNames(List<String> 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

getOverview

String getOverview()

setOverview

void setOverview(String overview)

overview

MinimalJavadocOptions overview(String overview)

getMemberLevel

JavadocMemberLevel getMemberLevel()

setMemberLevel

void setMemberLevel(JavadocMemberLevel memberLevel)

showFromPublic

MinimalJavadocOptions showFromPublic()

showFromProtected

MinimalJavadocOptions showFromProtected()

showFromPackage

MinimalJavadocOptions showFromPackage()

showFromPrivate

MinimalJavadocOptions showFromPrivate()

showAll

MinimalJavadocOptions showAll()

getDoclet

String getDoclet()

setDoclet

void setDoclet(String docletClass)

doclet

MinimalJavadocOptions doclet(String docletClass)

getDocletpath

List<File> getDocletpath()

setDocletpath

void setDocletpath(List<File> docletpath)

docletpath

MinimalJavadocOptions docletpath(File... docletpath)

getSource

String getSource()

setSource

void setSource(String source)

source

MinimalJavadocOptions source(String source)

getClasspath

List<File> getClasspath()

setClasspath

void setClasspath(List<File> classpath)

classpath

MinimalJavadocOptions classpath(List<File> classpath)

classpath

MinimalJavadocOptions classpath(File... classpath)

getBootClasspath

List<File> getBootClasspath()

setBootClasspath

void setBootClasspath(List<File> bootClasspath)

bootClasspath

MinimalJavadocOptions bootClasspath(File... bootClasspath)

getExtDirs

List<File> getExtDirs()

setExtDirs

void setExtDirs(List<File> extDirs)

extDirs

MinimalJavadocOptions extDirs(File... extDirs)

getOutputLevel

JavadocOutputLevel getOutputLevel()

setOutputLevel

void setOutputLevel(JavadocOutputLevel outputLevel)

verbose

MinimalJavadocOptions verbose()

isVerbose

boolean isVerbose()

quiet

MinimalJavadocOptions quiet()

isBreakIterator

boolean isBreakIterator()

setBreakIterator

void setBreakIterator(boolean breakIterator)

breakIterator

MinimalJavadocOptions breakIterator(boolean breakIterator)

breakIterator

MinimalJavadocOptions breakIterator()

getLocale

String getLocale()

setLocale

void setLocale(String locale)

locale

MinimalJavadocOptions locale(String locale)

getEncoding

String getEncoding()

setEncoding

void setEncoding(String encoding)

encoding

MinimalJavadocOptions encoding(String encoding)

getJFlags

List<String> getJFlags()

setJFlags

void setJFlags(List<String> jFlags)

jFlags

MinimalJavadocOptions jFlags(String... jFlags)

getOptionFiles

List<File> getOptionFiles()

setOptionFiles

void setOptionFiles(List<File> optionFiles)

optionFiles

MinimalJavadocOptions optionFiles(File... argumentFiles)

getDestinationDirectory

File getDestinationDirectory()

setDestinationDirectory

void setDestinationDirectory(File directory)

destinationDirectory

MinimalJavadocOptions destinationDirectory(File directory)

getWindowTitle

String getWindowTitle()

setWindowTitle

void setWindowTitle(String windowTitle)

windowTitle

StandardJavadocDocletOptions windowTitle(String windowTitle)

getHeader

String getHeader()

setHeader

void setHeader(String header)

header

StandardJavadocDocletOptions header(String header)

write

void write(File outputFile)
           throws IOException
Throws:
IOException

getSourceNames

List<String> getSourceNames()

setSourceNames

void setSourceNames(List<String> sourceNames)

sourceNames

MinimalJavadocOptions sourceNames(String... sourceNames)

contributeCommandLineOptions

void contributeCommandLineOptions(ExecSpec execHandleBuilder)
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD