java.lang.Comparable<Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.IConventionAware, org.gradle.api.internal.TaskInternal, ExtensionAware, Task, PatternFilterable, Configurable<Task>@CacheableTask public abstract 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 abstract 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.
|
java.io.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() |
A JavaLauncher used to run the Scaladoc tool.
|
protected abstract JavaToolchainService |
getJavaToolchainService() |
|
Property<java.lang.String> |
getMaxMemory() |
Returns the amount of memory allocated to this task.
|
protected abstract 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.
|
java.lang.String |
getTitle() |
Returns the documentation title.
|
protected abstract WorkerExecutor |
getWorkerExecutor() |
|
void |
setClasspath(FileCollection classpath) |
|
void |
setDestinationDir(java.io.File destinationDir) |
|
void |
setScalaClasspath(FileCollection scalaClasspath) |
|
void |
setScalaDocOptions(ScalaDocOptions scalaDocOptions) |
|
void |
setTitle(java.lang.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, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesServiceacceptServiceReferences, appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, setImpliesSubProjectsclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitdoNotTrackState, getConvention, notCompatibleWithConfigurationCache@OutputDirectory public java.io.File getDestinationDir()
public void setDestinationDir(java.io.File destinationDir)
@PathSensitive(RELATIVE) public FileTree getSource()
The PathSensitivity for the sources is configured to be PathSensitivity.RELATIVE.
getSource in class SourceTask@InputFiles @IgnoreEmptyDirectories @PathSensitive(RELATIVE) protected FileTree getFilteredCompilationOutputs()
NOTE: This is only useful with Scala 3 or later. Scala 2 only processes source files.
@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)
@Nullable @Optional @Input public java.lang.String getTitle()
public void setTitle(@Nullable
java.lang.String title)
@Internal public Property<java.lang.String> getMaxMemory()
public Property<JavaLauncher> getJavaLauncher()
protected void generate()
@Inject protected abstract ObjectFactory getObjectFactory()
@Inject protected abstract org.gradle.api.internal.project.IsolatedAntBuilder getAntBuilder()
@Inject protected abstract WorkerExecutor getWorkerExecutor()
@Inject protected abstract JavaToolchainService getJavaToolchainService()