Class AbstractJavaDoc

java.lang.Object
build.spin.module.java.AbstractJavaDoc
All Implemented Interfaces:
JavaCompilerPlugin.JavaDoc, build.spin.Task<Path>
Direct Known Subclasses:
Java25CompilerPlugin.JavaDoc, Java8CompilerPlugin.JavaDoc
public abstract class AbstractJavaDoc extends Object implements JavaCompilerPlugin.JavaDoc
An abstract Task that compiles and produces Java Documentation for the Java Source Code in a Project using the Java Platform javadoc command.
Since:
Mar-2021
Author:
brian.oliver

  • Nested Class Summary

    Nested classes/interfaces inherited from interface build.spin.Task

    build.spin.Task.Pattern

  • Constructor Summary

    Constructors
    Constructor
    Description
    AbstractJavaDoc()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected Path
    javadoc(build.base.io.PathSet sourceCode, build.spawn.jdk.option.ModulePath modulePath, build.spawn.jdk.option.ClassPath classPath, Path buildPath, Optional<URL> javaPlatformURL)
    Compiles and produces Java Documentation from the source code in the provided PathSet, outputting it into the specified build Path.

    Methods inherited from class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface build.spin.Task

    dependencies, execute

  • Constructor Details

    • AbstractJavaDoc

      public AbstractJavaDoc()

  • Method Details

    • javadoc

      protected Path javadoc(build.base.io.PathSet sourceCode, build.spawn.jdk.option.ModulePath modulePath, build.spawn.jdk.option.ClassPath classPath, Path buildPath, Optional<URL> javaPlatformURL) throws Exception
      Compiles and produces Java Documentation from the source code in the provided PathSet, outputting it into the specified build Path.
      Parameters:
      sourceCode - the source code
      modulePath - the ModulePath (empty for non-modular projects)
      classPath - the ClassPath
      buildPath - the build Path (.build)
      javaPlatformURL - the Optional URL for the external Java Development Kit documentation
      Returns:
      the Path containing the generated documentation
      Throws:
      Exception - should documentation fail