|
Groovy Documentation | |||||||
FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.gradle.api.internal.ConventionTask
org.gradle.api.tasks.SourceTask
org.gradle.api.tasks.scala.ScalaDoc
class ScalaDoc extends SourceTask
Task to generate Scala API documentation.
Constructor Summary | |
ScalaDoc()
|
Method Summary | |
---|---|
protected void
|
generate()
|
AntScalaDoc
|
getAntScalaDoc()
|
java.lang.Iterable
|
getClasspath()
Returns the classpath to use to locate classes referenced by the documented source. |
File
|
getDestinationDir()
|
ScalaDocOptions
|
getScalaDocOptions()
|
java.lang.String
|
getTitle()
|
void
|
setAntScalaDoc(AntScalaDoc antScalaDoc)
|
void
|
setClasspath(FileCollection classpath)
|
void
|
setDestinationDir(File destinationDir)
|
void
|
setScalaDocOptions(ScalaDocOptions scalaDocOptions)
|
void
|
setTitle(java.lang.String title)
|
Methods inherited from class SourceTask | |
---|---|
exclude, exclude, getDefaultSource, getExcludes, getIncludes, getSource, include, include, setExcludes, setIncludes, setSource, source |
Constructor Detail |
---|
ScalaDoc()
Method Detail |
---|
@TaskAction protected void generate()
public AntScalaDoc getAntScalaDoc()
@InputFiles public java.lang.Iterable getClasspath()
Returns the classpath to use to locate classes referenced by the documented source.
@OutputDirectory public File getDestinationDir()
public ScalaDocOptions getScalaDocOptions()
public java.lang.String getTitle()
public void setAntScalaDoc(AntScalaDoc antScalaDoc)
public void setClasspath(FileCollection classpath)
public void setDestinationDir(File destinationDir)
public void setScalaDocOptions(ScalaDocOptions scalaDocOptions)
public void setTitle(java.lang.String title)
Groovy Documentation