Class ScalaDoc

    • Constructor Detail

      • ScalaDoc

        public ScalaDoc()
    • Method Detail

      • 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.

        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.

        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)
      • generate

        protected void generate()