Class Java8CompilerPlugin.JavaDoc

java.lang.Object

build.spin.module.java.AbstractJavaDoc

build.spin.module.java.Java8CompilerPlugin.JavaDoc

All Implemented Interfaces:

JavaCompilerPlugin.JavaDoc, build.spin.Task<Path>

Enclosing class:

Java8CompilerPlugin

@Named("javadoc")
@Category("document") @Category("build")
@After(Java8CompilerPlugin.Compile.class)
public static class Java8CompilerPlugin.JavaDoc
extends AbstractJavaDoc

A Task to generate Java Documentation from the source code in the Project.

Since:

Jul-2019

Author:

brian.oliver

Nested Class Summary

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

build.spin.Task.Pattern

Constructor Summary

Constructors

Constructor	Description
JavaDoc()

Method Summary

Modifier and Type	Method	Description
Path	javadoc(build.base.io.PathSet sourceCode, build.spawn.jdk.option.ModulePath modulePath, build.spawn.jdk.option.ClassPath classPath, Path buildPath)	Generates Java Documentation from the source code in the Project.

Methods inherited from class AbstractJavaDoc

javadoc

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

JavaDoc

public JavaDoc()

Method Details

javadoc

public Path javadoc(@From(Java8CompilerPlugin.DetectSourceFiles.class)
 build.base.io.PathSet sourceCode,
 @From(Java8CompilerPlugin.DetectCompilationModulePath.class)
 build.spawn.jdk.option.ModulePath modulePath,
 @From(Java8CompilerPlugin.DetectCompilationClassPath.class)
 build.spawn.jdk.option.ClassPath classPath,
 @From(build.spin.module.clean.CleanPlugin.CreateBuildPath.class)
 Path buildPath)
             throws Exception

Generates Java Documentation from the source code in the Project.

Parameters:

sourceCode - the source code

modulePath - the ModulePath

classPath - the ClassPath

buildPath - the build Path

Returns:

the Path of the generated documentation

Throws:

Exception - should documentation fail