Comparable<Task>
, org.gradle.api.internal.DynamicObjectAware
, org.gradle.api.internal.IConventionAware
, org.gradle.api.internal.TaskInternal
, ExtensionAware
, Task
, PatternFilterable
, org.gradle.util.Configurable<Task>
public class ScalaDoc extends SourceTask
Task.Namer
source
TASK_ACTION, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE
Constructor | Description |
---|---|
ScalaDoc() |
Modifier and Type | Method | 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) |
addValidator, appendParallelSafeAction, compareTo, configure, deleteAllActions, dependsOn, dependsOnTaskDidWork, doFirst, doFirst, doLast, doLast, execute, finalizedBy, getActionClassLoaders, getActions, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDescription, getDidWork, getEnabled, getExecuter, getExtensions, getFinalizedBy, getGroup, getIdentityPath, 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, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, toString
conventionMapping, conventionMapping, getConventionMapping
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
exclude, exclude, exclude, exclude, getExcludes, getIncludes, getPatternSetFactory, getSource, include, include, include, include, setExcludes, setIncludes, setSource, source
@Inject protected org.gradle.api.internal.project.IsolatedAntBuilder getAntBuilder()
@OutputDirectory public File getDestinationDir()
public void setDestinationDir(File destinationDir)
@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)
public void setTitle(String title)
protected void generate()