public final class JkJavadocMaker
extends java.lang.Object
Modifier and Type | Method and Description |
---|---|
JkJavadocMaker |
andOptions(java.util.List<java.lang.String> options)
Returns a
JkJavadocMaker identical to this one but using the specified options (-classpath , -exclude, -subpackages, ...). |
JkJavadocMaker |
andOptions(java.lang.String... options)
Returns a
JkJavadocMaker identical to this one but using the specified options (-classpath , -exclude, -subpackages, ...). |
static JkJavadocMaker |
of(JkPathTreeSet sources,
java.nio.file.Path outputDir)
Creates a
JkJavadocMaker from the specified sources. |
static JkJavadocMaker |
of(JkPathTreeSet sources,
java.nio.file.Path outputDir,
java.nio.file.Path zipFile)
Creates a
JkJavadocMaker from the specified sources. |
void |
process()
Actually processes and creates the javadoc files.
|
JkJavadocMaker |
withClasspath(java.lang.Iterable<java.nio.file.Path> classpath)
Returns a
JkJavadocMaker identical to this one but using the specified classpath. |
JkJavadocMaker |
withDoclet(java.lang.Class<?> doclet)
Returns a
JkJavadocMaker identical to this one but using the specified doclet. |
java.nio.file.Path |
zipFile()
Returns the zip file containing all the produced Javadoc.
|
public static JkJavadocMaker of(JkPathTreeSet sources, java.nio.file.Path outputDir, java.nio.file.Path zipFile)
JkJavadocMaker
from the specified sources. The result will be outputed in
the specified directory then compacted in the specified zip file.public static JkJavadocMaker of(JkPathTreeSet sources, java.nio.file.Path outputDir)
JkJavadocMaker
from the specified sources. The result will be outputed in
the specified directory.public java.nio.file.Path zipFile()
public JkJavadocMaker withDoclet(java.lang.Class<?> doclet)
JkJavadocMaker
identical to this one but using the specified doclet.public JkJavadocMaker andOptions(java.lang.String... options)
JkJavadocMaker
identical to this one but using the specified options (-classpath , -exclude, -subpackages, ...).public JkJavadocMaker andOptions(java.util.List<java.lang.String> options)
JkJavadocMaker
identical to this one but using the specified options (-classpath , -exclude, -subpackages, ...).public JkJavadocMaker withClasspath(java.lang.Iterable<java.nio.file.Path> classpath)
JkJavadocMaker
identical to this one but using the specified classpath.public void process()