org.apache.maven.plugin.javadoc
Class TestFixJavadocMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.maven.plugin.javadoc.AbstractFixJavadocMojo
          org.apache.maven.plugin.javadoc.TestFixJavadocMojo

All Implemented Interfaces:

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

public class TestFixJavadocMojo
extends AbstractFixJavadocMojo

Fix Javadoc documentation and tags for the Test Java code for the project. See Where Tags Can Be Used.

Since:

2.6

Version:

$Id: TestFixJavadocMojo.html 829396 2012-08-19 17:35:19Z hboutemy $

Author:

Vincent Siveton

Is defined to be executed in:

phase:

test-compile

Is defined by the goal name:

test-fix

Requires the dependencies in this specified scope:

test

Field Summary

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

ignoreClirr

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

ROLE

Constructor Summary

TestFixJavadocMojo()

Method Summary

void	execute()
protected String	getArtifactType(org.apache.maven.project.MavenProject p)
protected List	getCompileClasspathElements(org.apache.maven.project.MavenProject p)
protected List	getProjectSourceRoots(org.apache.maven.project.MavenProject p)

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

getJavaMethodAsString

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 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 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