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>@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.
|
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, sourceconventionMapping, conventionMapping, getConventionMappingnewInputDirectory, newInputFile, newOutputDirectory, newOutputFileappendParallelSafeAction, compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getIdentityPath, getImpliesSubProjects, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOnlyIf, getOutputs, getPath, getProject, getServices, getShouldRunAfter, getStandardOutputCapture, getState, getTaskActions, getTaskDependencies, getTaskIdentity, getTemporaryDir, getTemporaryDirFactory, getTimeout, hasProperty, hasTaskActions, injectIntoNewInstance, isEnabled, isHasCustomActions, mustRunAfter, onlyIf, onlyIf, prependParallelSafeAction, property, replaceLogger, setActions, setDependsOn, setDescription, setDidWork, setEnabled, 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(RELATIVE) public FileTree getSource()
The PathSensitivity for the sources is configured to be PathSensitivity.ABSOLUTE.
If your sources are less strict, please change it accordingly by overriding this method in your subclass.
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)
public void setTitle(@Nullable
String title)
protected void generate()