public class ScalaDoc extends SourceTask
Task.Namer
TASK_ACTION, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE
Constructor and Description |
---|
ScalaDoc() |
Modifier and Type | Method and Description |
---|---|
protected void |
generate() |
org.gradle.api.tasks.scala.AntScalaDoc |
getAntScalaDoc() |
Iterable<File> |
getClasspath()
Returns the classpath to use to locate classes referenced by the documented source.
|
File |
getDestinationDir()
Returns the directory to generate the API documentation into.
|
FileCollection |
getScalaClasspath()
Returns the classpath to use to load the ScalaDoc tool.
|
org.gradle.api.tasks.scala.ScalaDocOptions |
getScalaDocOptions()
Returns the ScalaDoc generation options.
|
String |
getTitle()
Returns the documentation title.
|
void |
setAntScalaDoc(org.gradle.api.tasks.scala.AntScalaDoc antScalaDoc) |
void |
setClasspath(FileCollection classpath) |
void |
setDestinationDir(File destinationDir) |
void |
setScalaClasspath(FileCollection scalaClasspath) |
void |
setScalaDocOptions(org.gradle.api.tasks.scala.ScalaDocOptions scalaDocOptions) |
void |
setTitle(String title) |
exclude, exclude, exclude, exclude, getDefaultSource, getExcludes, getIncludes, getSource, include, include, include, include, setExcludes, setIncludes, setSource, source
conventionMapping, conventionMapping, getConventionMapping
addValidator, compareTo, configure, deleteAllActions, dependsOn, dependsOnTaskDidWork, doFirst, doFirst, doLast, doLast, execute, executeWithoutThrowingTaskFailure, getActions, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDescription, getDidWork, getEnabled, getExecuter, getExtensions, getGroup, getInputs, getLogger, getLogging, getName, getOnlyIf, getOutputs, getPath, getProject, getServices, getStandardOutputCapture, getState, getTaskDependencies, getTemporaryDir, getTemporaryDirFactory, getValidators, hasProperty, injectIntoNewInstance, isEnabled, leftShift, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setExecuter, setGroup, setName, setOnlyIf, setOnlyIf, setProject, setProperty, toString
public org.gradle.api.tasks.scala.AntScalaDoc getAntScalaDoc()
public void setAntScalaDoc(org.gradle.api.tasks.scala.AntScalaDoc antScalaDoc)
@OutputDirectory public File getDestinationDir()
public void setDestinationDir(File destinationDir)
@InputFiles public Iterable<File> getClasspath()
Returns the classpath to use to locate classes referenced by the documented source.
public void setClasspath(FileCollection classpath)
@InputFiles public FileCollection getScalaClasspath()
public void setScalaClasspath(FileCollection scalaClasspath)
public org.gradle.api.tasks.scala.ScalaDocOptions getScalaDocOptions()
public void setScalaDocOptions(org.gradle.api.tasks.scala.ScalaDocOptions scalaDocOptions)
public void setTitle(String title)
protected void generate()