@Mojo(name="javadoc",
defaultPhase=PROCESS_CLASSES,
requiresDependencyResolution=COMPILE_PLUS_RUNTIME,
threadSafe=false)
public class JavadocMojo
extends org.apache.maven.plugin.AbstractMojo
Modifier and Type | Class and Description |
---|---|
private class |
JavadocMojo.GatherClasspathVisitor |
private class |
JavadocMojo.GatherManifestVisitor |
private class |
JavadocMojo.GatherSourcesVisitor |
private static interface |
JavadocMojo.ProjectVisitor |
Modifier and Type | Field and Description |
---|---|
private java.io.File |
basedir
The base output directory
|
private java.io.File |
buildDirectory
The build directory where temporary build files will be placed
|
private org.eclipse.tycho.core.osgitools.BundleReader |
bundleReader |
private boolean |
cleanFirst
An option to clean out the whole outputDirectory first.
|
private DocletArtifactsResolver |
docletArtifactsResolver |
private JavadocOptions |
javadocOptions
Options for calling the javadoc application.
|
private java.io.File |
outputDirectory
The directory where the javadoc content will be generated
|
private java.lang.String |
projectBuildSourceEncoding |
protected java.util.List<org.apache.maven.project.MavenProject> |
reactorProjects |
private java.util.Set<java.lang.String> |
scopes
The scopes that the dependencies must have in order to be included
|
private org.apache.maven.execution.MavenSession |
session |
private boolean |
skipTocGen
Set this property to true to skip the generation of the Eclipse TOC files.
|
private java.util.Set<java.lang.String> |
sourceTypes
Maven module types that will be used to include the source
|
private java.io.File |
tocFile
The output location of the toc file.
This file will be overwritten. |
private TocOptions |
tocOptions
Options for creating the toc files.
|
private org.apache.maven.toolchain.ToolchainManager |
toolchainManager |
Constructor and Description |
---|
JavadocMojo() |
Modifier and Type | Method and Description |
---|---|
private void |
cleanUp() |
void |
execute() |
private org.apache.maven.project.MavenProject |
findProject(java.lang.String groupId,
java.lang.String artifactId) |
void |
setJavadocOptions(JavadocOptions javadocOptions) |
void |
setScopes(java.util.Set<java.lang.String> scopes) |
void |
setSourceTypes(java.util.Set<java.lang.String> sourceTypes) |
void |
setTocOptions(TocOptions tocOptions) |
private void |
visitDeps(org.apache.maven.model.Dependency dep,
JavadocMojo.ProjectVisitor visitor,
java.util.Set<java.lang.String> scopes) |
private void |
visitProjects(java.util.List<?> dependencies,
java.util.Set<java.lang.String> scopes,
JavadocMojo.ProjectVisitor visitor) |
@Parameter(property="outputDirectory", defaultValue="${project.build.directory}/reference/api", required=true) private java.io.File outputDirectory
@Parameter(property="basedir", required=true, readonly=true) private java.io.File basedir
@Parameter(property="project.build.directory", required=true) private java.io.File buildDirectory
@Parameter(property="cleanFirst", defaultValue="true") private boolean cleanFirst
@Component private org.apache.maven.toolchain.ToolchainManager toolchainManager
@Parameter(property="session", required=true, readonly=true) private org.apache.maven.execution.MavenSession session
@Parameter(property="reactorProjects", required=true, readonly=true) protected java.util.List<org.apache.maven.project.MavenProject> reactorProjects
@Parameter(property="scopes", defaultValue="compile,provided") private java.util.Set<java.lang.String> scopes
@Parameter(property="sourceTypes", defaultValue="eclipse-plugin") private java.util.Set<java.lang.String> sourceTypes
@Parameter(property="javadocOptions") private JavadocOptions javadocOptions
<configuration> <javadocOptions> <ignoreError>false</ignoreError> <encoding>UTF-8</encoding> <doclet>foo.bar.MyDoclet</doclet> <docletArtifacts> <docletArtifact> <groupId>foo.bar</groupId> <artifactId>foo.bar.mydocletartifact</artifactId> <version>1.0</version> </docletArtifact> </docletArtifacts> <includes> <include>com.example.*</include> </includes> <excludes> <exclude>com.example.internal.*</exclude> </excludes> <additionalArguments> <additionalArgument>-windowtitle "The Window Title"</additionalArgument> <additionalArgument>-nosince</additionalArgument> </additionalArguments> </javadocOptions> </configuration>
@Parameter(property="tocOptions") private TocOptions tocOptions
<configuration> <tocOptions> <mainLabel>My own label</mainLabel> <mainFilename>myOverviewSummary.html</mainFilename> </tocOptions> </configuration>
@Parameter(property="skipTocGen", defaultValue="false") private boolean skipTocGen
@Parameter(property="tocFile", defaultValue="${project.build.directory}/tocjavadoc.xml") private java.io.File tocFile
@Parameter(property="project.build.sourceEncoding", readonly=true) private java.lang.String projectBuildSourceEncoding
@Component private org.eclipse.tycho.core.osgitools.BundleReader bundleReader
@Component private DocletArtifactsResolver docletArtifactsResolver
public void setTocOptions(TocOptions tocOptions)
public void setSourceTypes(java.util.Set<java.lang.String> sourceTypes)
public void setScopes(java.util.Set<java.lang.String> scopes)
public void setJavadocOptions(JavadocOptions javadocOptions)
public void execute() throws org.apache.maven.plugin.MojoExecutionException
org.apache.maven.plugin.MojoExecutionException
private void cleanUp() throws org.apache.maven.plugin.MojoExecutionException
org.apache.maven.plugin.MojoExecutionException
private void visitProjects(java.util.List<?> dependencies, java.util.Set<java.lang.String> scopes, JavadocMojo.ProjectVisitor visitor) throws org.apache.maven.plugin.MojoExecutionException
org.apache.maven.plugin.MojoExecutionException
private void visitDeps(org.apache.maven.model.Dependency dep, JavadocMojo.ProjectVisitor visitor, java.util.Set<java.lang.String> scopes) throws org.apache.maven.plugin.MojoExecutionException
org.apache.maven.plugin.MojoExecutionException
private org.apache.maven.project.MavenProject findProject(java.lang.String groupId, java.lang.String artifactId)