Comparable<Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.IConventionAware, org.gradle.api.internal.TaskInternal, ExtensionAware, Task, PatternFilterable, Configurable<Task>@CacheableTask public class ScalaDoc extends SourceTask
Task.NamerTASK_ACTION, TASK_CONSTRUCTOR_ARGS, 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.
|
ConfigurableFileCollection |
getCompilationOutputs() |
Returns the compilation outputs produced by the sources that are generating Scaladoc.
|
File |
getDestinationDir() |
Returns the directory to generate the API documentation into.
|
protected FileTree |
getFilteredCompilationOutputs() |
Returns the compilation outputs needed by Scaladoc filtered to include TASTy files.
|
Property<JavaLauncher> |
getJavaLauncher() |
Optional JavaLauncher for toolchain support
|
Property<String> |
getMaxMemory() |
Returns the amount of memory allocated to this task.
|
ObjectFactory |
getObjectFactory() |
|
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.
|
WorkerExecutor |
getWorkerExecutor() |
|
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, getPatternSet, getPatternSetFactory, include, include, include, include, setExcludes, setIncludes, setSource, setSource, sourceconventionMapping, conventionMapping, getConventionMappingcompareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesServiceappendParallelSafeAction, doNotTrackState, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getOnlyIf, getReasonNotToTrackState, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isEnabled, isHasCustomActions, prependParallelSafeAction, setImpliesSubProjectsclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitdoNotTrackState, getConvention@Inject protected org.gradle.api.internal.project.IsolatedAntBuilder getAntBuilder()
@Inject public WorkerExecutor getWorkerExecutor()
@Inject public ObjectFactory getObjectFactory()
@OutputDirectory public File getDestinationDir()
public void setDestinationDir(File destinationDir)
@PathSensitive(RELATIVE) public FileTree getSource()
The PathSensitivity for the sources is configured to be PathSensitivity.RELATIVE.
getSource in class SourceTask@Incubating @InputFiles @IgnoreEmptyDirectories @PathSensitive(RELATIVE) protected FileTree getFilteredCompilationOutputs()
NOTE: This is only useful with Scala 3 or later. Scala 2 only processes source files.
@Incubating @Internal public ConfigurableFileCollection getCompilationOutputs()
@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)
@Internal public Property<String> getMaxMemory()
@Incubating @Internal public Property<JavaLauncher> getJavaLauncher()
protected void generate()