Package org.gradle.api.tasks.scala
Class ScalaDoc
java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
org.gradle.api.internal.ConventionTask
org.gradle.api.tasks.SourceTask
org.gradle.api.tasks.scala.ScalaDoc
- All Implemented Interfaces:
- Comparable<Task>,- org.gradle.api.internal.DynamicObjectAware,- org.gradle.api.internal.IConventionAware,- org.gradle.api.internal.TaskInternal,- Named,- ExtensionAware,- Task,- PatternFilterable,- Configurable<Task>
Generates HTML API documentation for Scala source files.
- 
Nested Class SummaryNested classes/interfaces inherited from interface org.gradle.api.TaskTask.Namer
- 
Field SummaryFields inherited from interface org.gradle.api.TaskTASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionprotected voidgenerate()protected abstract org.gradle.api.internal.project.IsolatedAntBuilderDeprecated.Returns the classpath to use to locate classes referenced by the documented source.Returns the compilation outputs produced by the sources that are generating Scaladoc.Returns the directory to generate the API documentation into.protected FileTreeReturns the compilation outputs needed by Scaladoc filtered to include TASTy files.A JavaLauncher used to run the Scaladoc tool.protected abstract JavaToolchainServiceReturns the amount of memory allocated to this task.protected abstract ObjectFactoryReturns the classpath to use to load the ScalaDoc tool.Returns the ScalaDoc generation options.Returns the source for this task, after the include and exclude patterns have been applied.getTitle()Returns the documentation title.protected abstract WorkerExecutorvoidscalaDocOptions(Action<? super ScalaDocOptions> action) Configures the ScalaDoc generation options.voidsetClasspath(FileCollection classpath) voidsetDestinationDir(File destinationDir) voidsetScalaClasspath(FileCollection scalaClasspath) voidsetScalaDocOptions(ScalaDocOptions scalaDocOptions) Deprecated.Setting a new instance of this property is unnecessary.voidMethods inherited from class org.gradle.api.tasks.SourceTaskexclude, exclude, exclude, exclude, getExcludes, getIncludes, getPatternSet, getPatternSetFactory, include, include, include, include, setExcludes, setIncludes, setSource, setSource, sourceMethods inherited from class org.gradle.api.internal.ConventionTaskconventionMapping, conventionMapping, getConventionMappingMethods inherited from class org.gradle.api.DefaultTaskcompareTo, 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, usesServiceMethods inherited from class org.gradle.api.internal.AbstractTaskacceptServiceReferences, appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, setImpliesSubProjectsMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.gradle.api.TaskdoNotTrackState, getConvention, notCompatibleWithConfigurationCache
- 
Constructor Details- 
ScalaDocpublic ScalaDoc()
 
- 
- 
Method Details- 
getDestinationDirReturns the directory to generate the API documentation into.
- 
setDestinationDir
- 
getSourceReturns the source for this task, after the include and exclude patterns have been applied. Ignores source files which do not exist.The PathSensitivityfor the sources is configured to bePathSensitivity.RELATIVE.- Overrides:
- getSourcein class- SourceTask
- Returns:
- The source.
 
- 
getFilteredCompilationOutputs@InputFiles @IgnoreEmptyDirectories @PathSensitive(RELATIVE) protected FileTree getFilteredCompilationOutputs()Returns the compilation outputs needed by Scaladoc filtered to include TASTy files.NOTE: This is only useful with Scala 3 or later. Scala 2 only processes source files. - Returns:
- the compilation outputs produced from the sources
- Since:
- 7.3
 
- 
getCompilationOutputsReturns the compilation outputs produced by the sources that are generating Scaladoc.- Returns:
- the compilation outputs produced from the sources
- Since:
- 7.3
 
- 
getClasspathReturns the classpath to use to locate classes referenced by the documented source. - Returns:
- The classpath.
 
- 
setClasspath
- 
getScalaClasspathReturns the classpath to use to load the ScalaDoc tool.
- 
setScalaClasspath
- 
getScalaDocOptionsReturns the ScalaDoc generation options.
- 
setScalaDocOptionsDeprecated.Setting a new instance of this property is unnecessary. This method will be removed in Gradle 9.0. UsescalaDocOptions(Action)instead.Sets the ScalaDoc generation options.
- 
scalaDocOptionsConfigures the ScalaDoc generation options.- Since:
- 8.11
 
- 
getTitleReturns the documentation title.
- 
setTitle
- 
getMaxMemoryReturns the amount of memory allocated to this task. Ex. 512m, 1G- Since:
- 6.5
 
- 
getJavaLauncherA JavaLauncher used to run the Scaladoc tool.- Since:
- 7.2
 
- 
generateprotected void generate()
- 
getObjectFactory
- 
getAntBuilder@Inject @Deprecated protected abstract org.gradle.api.internal.project.IsolatedAntBuilder getAntBuilder()Deprecated.
- 
getWorkerExecutor
- 
getJavaToolchainService
 
-