public class ScalaDoc extends SourceTask
Task.NamersourceTASK_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() |
protected org.gradle.api.internal.project.IsolatedAntBuilder |
getAntBuilder() |
FileCollection |
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.
|
ScalaDocOptions |
getScalaDocOptions()
Returns the ScalaDoc generation options.
|
String |
getTitle()
Returns the documentation title.
|
void |
setClasspath(FileCollection classpath) |
void |
setDestinationDir(File destinationDir) |
void |
setScalaClasspath(FileCollection scalaClasspath) |
void |
setScalaDocOptions(ScalaDocOptions scalaDocOptions) |
void |
setTitle(String title) |
exclude, exclude, exclude, exclude, getExcludes, getIncludes, getPatternSetFactory, getSource, include, include, include, include, setExcludes, setIncludes, setSource, sourceconventionMapping, conventionMapping, getConventionMappingaddValidator, appendParallelSafeAction, compareTo, configure, deleteAllActions, dependsOn, dependsOnTaskDidWork, doFirst, doFirst, doLast, doLast, execute, finalizedBy, getActions, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDescription, getDidWork, getEnabled, getExecuter, getExtensions, getFinalizedBy, getGroup, getImpliesSubProjects, getInputs, getLogger, getLogging, getMustRunAfter, getName, getOnlyIf, getOutputs, getPath, getProject, getServices, getShouldRunAfter, getStandardOutputCapture, getState, getTaskActions, getTaskDependencies, getTemporaryDir, getTemporaryDirFactory, getValidators, hasProperty, injectIntoNewInstance, isEnabled, isHasCustomActions, leftShift, mustRunAfter, onlyIf, onlyIf, prependParallelSafeAction, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setExecuter, setFinalizedBy, setGroup, setImpliesSubProjects, setMustRunAfter, setName, setOnlyIf, setOnlyIf, setProject, setProperty, setShouldRunAfter, shouldRunAfter, toString@Inject protected org.gradle.api.internal.project.IsolatedAntBuilder getAntBuilder()
@OutputDirectory public File getDestinationDir()
public void setDestinationDir(File destinationDir)
@InputFiles public FileCollection 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 ScalaDocOptions getScalaDocOptions()
public void setScalaDocOptions(ScalaDocOptions scalaDocOptions)
public void setTitle(String title)
protected void generate()