org.apache.maven.plugins.javadoc

Class TestFixJavadocMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugins.javadoc.AbstractFixJavadocMojo

org.apache.maven.plugins.javadoc.TestFixJavadocMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="test-fix",
      requiresDependencyResolution=TEST,
      threadSafe=true)
 @Execute(phase=TEST_COMPILE)
public class TestFixJavadocMojo
extends AbstractFixJavadocMojo

Fix Javadoc documentation and tags for the Test Java code for the project.

Since:

2.6

Author:

Vincent Siveton

See Also:

Where Tags Can Be Used

Field Summary

Fields inherited from class org.apache.maven.plugins.javadoc.AbstractFixJavadocMojo

DEFAULT_VERSION_VALUE, ignoreClirr, JAVA_FILES

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
TestFixJavadocMojo()

Method Summary

Modifier and Type	Method and Description
void	execute()
protected String	getArtifactType(org.apache.maven.project.MavenProject p)
protected List<String>	getCompileClasspathElements(org.apache.maven.project.MavenProject p)
protected List<String>	getProjectSourceRoots(org.apache.maven.project.MavenProject p)

Methods inherited from class org.apache.maven.plugins.javadoc.AbstractFixJavadocMojo

getJavaMethodAsString, getProject

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Constructor Detail

TestFixJavadocMojo

public TestFixJavadocMojo()

Method Detail

getProjectSourceRoots

protected List<String> getProjectSourceRoots(org.apache.maven.project.MavenProject p)

Overrides:

getProjectSourceRoots in class AbstractFixJavadocMojo

Parameters:

p - not null maven project.

Returns:

the list of source paths for the given project.

getCompileClasspathElements

protected List<String> getCompileClasspathElements(org.apache.maven.project.MavenProject p)
                                            throws org.apache.maven.artifact.DependencyResolutionRequiredException

Overrides:

getCompileClasspathElements in class AbstractFixJavadocMojo

Parameters:

p - not null

Returns:

the compile classpath elements

Throws:

org.apache.maven.artifact.DependencyResolutionRequiredException - if any

getArtifactType

protected String getArtifactType(org.apache.maven.project.MavenProject p)

Overrides:

getArtifactType in class AbstractFixJavadocMojo

Parameters:

p - not null maven project.

Returns:

the artifact type.

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Overrides:

execute in class AbstractFixJavadocMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException