dev.jeka.core.api.java

Class JkJavadocProcessor

java.lang.Object

dev.jeka.core.api.java.JkJavadocProcessor

public final class JkJavadocProcessor
extends java.lang.Object

Provides fluent interface for producing Javadoc.

Constructor Summary

Constructors

Constructor and Description
JkJavadocProcessor()

Method Summary

Modifier and Type	Method and Description
JkJavadocProcessor	addOptions(java.lang.Iterable<java.lang.String> options)
JkJavadocProcessor	addOptions(java.lang.String... options) Adds the specified parameters to Javadoc tool.
java.util.List<java.lang.String>	getOptions() Returns the axtra arguments passed to the Javadoc tool.
void	make(java.lang.Iterable<java.nio.file.Path> classpath, JkPathTreeSet srcDirs, java.nio.file.Path outputDir) Actually processes and creates the javadoc files.
static JkJavadocProcessor	of() Creates a default JkJavadocProcessor .

Methods inherited from class java.lang.Object

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

Constructor Detail

JkJavadocProcessor

public JkJavadocProcessor()

Method Detail

of

public static JkJavadocProcessor of()

Creates a default JkJavadocProcessor .

getOptions

public java.util.List<java.lang.String> getOptions()

Returns the axtra arguments passed to the Javadoc tool.

addOptions

public JkJavadocProcessor addOptions(java.lang.String... options)

Adds the specified parameters to Javadoc tool.

addOptions

public JkJavadocProcessor addOptions(java.lang.Iterable<java.lang.String> options)

See Also:

addOptions(String...)

make

public void make(java.lang.Iterable<java.nio.file.Path> classpath,
                 JkPathTreeSet srcDirs,
                 java.nio.file.Path outputDir)

Actually processes and creates the javadoc files.