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, ExtensionAware, Task, PatternFilterable, org.gradle.util.Configurable<Task>
@CacheableTask public class ScalaDoc extends SourceTask
Generates HTML API documentation for Scala source files.

  • Constructor Details

    • ScalaDoc

      public ScalaDoc()

  • Method Details

    • getAntBuilder

      @Inject protected org.gradle.api.internal.project.IsolatedAntBuilder getAntBuilder()

    • getDestinationDir

      @OutputDirectory public File getDestinationDir()
      Returns the directory to generate the API documentation into.

    • setDestinationDir

      public void setDestinationDir(File destinationDir)

    • getSource

      @PathSensitive(RELATIVE) public FileTree getSource()
      Returns the source for this task, after the include and exclude patterns have been applied. Ignores source files which do not exist.
      Overrides:
      getSource in class SourceTask
      Returns:
      The source.

    • getClasspath

      @Classpath public FileCollection getClasspath()

      Returns the classpath to use to locate classes referenced by the documented source.

      Returns:
      The classpath.

    • setClasspath

      public void setClasspath(FileCollection classpath)

    • getScalaClasspath

      @Classpath public FileCollection getScalaClasspath()
      Returns the classpath to use to load the ScalaDoc tool.

    • setScalaClasspath

      public void setScalaClasspath(FileCollection scalaClasspath)

    • getScalaDocOptions

      public ScalaDocOptions getScalaDocOptions()
      Returns the ScalaDoc generation options.

    • setScalaDocOptions

      public void setScalaDocOptions(ScalaDocOptions scalaDocOptions)

    • getTitle

      @Input @Optional public String getTitle()
      Returns the documentation title.

    • setTitle

      public void setTitle(String title)

    • generate

      protected void generate()