@CacheableTask public class ScalaDoc extends SourceTask
Task.Namer
source
TASK_ACTION, TASK_CONSTRUCTOR_ARGS, 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.
|
FileTree |
getSource()
Returns the source for this task, after the include and exclude patterns have been applied.
|
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, include, include, include, include, setExcludes, setIncludes, setSource, setSource, source
conventionMapping, conventionMapping, getConventionMapping
newInputDirectory, newInputFile, newOutputDirectory, newOutputFile
addValidator, appendParallelSafeAction, compareTo, configure, deleteAllActions, dependsOn, dependsOnTaskDidWork, doFirst, doFirst, doFirst, doLast, doLast, doLast, execute, finalizedBy, getActions, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExecuter, getExtensions, getFinalizedBy, getGroup, getIdentityPath, getImpliesSubProjects, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOnlyIf, getOutputs, getPath, getProject, getServices, getShouldRunAfter, getStandardOutputCapture, getState, getTaskActions, getTaskDependencies, getTaskIdentity, getTemporaryDir, getTemporaryDirFactory, getValidators, hasProperty, hasTaskActions, injectIntoNewInstance, isEnabled, isHasCustomActions, leftShift, mustRunAfter, onlyIf, onlyIf, prependParallelSafeAction, property, replaceLogger, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setExecuter, setFinalizedBy, setGroup, setImpliesSubProjects, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, toString
@Inject protected org.gradle.api.internal.project.IsolatedAntBuilder getAntBuilder()
@OutputDirectory public File getDestinationDir()
public void setDestinationDir(File destinationDir)
@PathSensitive(value=RELATIVE) public FileTree getSource()
getSource
in class SourceTask
@Classpath public FileCollection getClasspath()
Returns the classpath to use to locate classes referenced by the documented source.
public void setClasspath(FileCollection classpath)
@Classpath public FileCollection getScalaClasspath()
public void setScalaClasspath(FileCollection scalaClasspath)
public ScalaDocOptions getScalaDocOptions()
public void setScalaDocOptions(ScalaDocOptions scalaDocOptions)
protected void generate()