org.apache.maven.plugin.javadoc
Class TestFixJavadocMojo

java.lang.Object
  extended by org.apache.maven.plugin.AbstractMojo
      extended by org.apache.maven.plugin.javadoc.AbstractFixJavadocMojo
          extended by org.apache.maven.plugin.javadoc.TestFixJavadocMojo
All Implemented Interfaces:
ContextEnabled, 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. See Where Tags Can Be Used.

Since:
2.6
Version:
$Id: TestFixJavadocMojo.html 922314 2014-09-15 20:18:14Z dennisl $
Author:
Vincent Siveton

Field Summary
 
Fields inherited from class org.apache.maven.plugin.javadoc.AbstractFixJavadocMojo
DEFAULT_VERSION_VALUE, ignoreClirr, JAVA_FILES
 
Fields inherited from interface org.apache.maven.plugin.Mojo
ROLE
 
Constructor Summary
TestFixJavadocMojo()
           
 
Method Summary
 void execute()
          
protected  String getArtifactType(MavenProject p)
          
protected  List<String> getCompileClasspathElements(MavenProject p)
          
protected  List<String> getProjectSourceRoots(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<String> getProjectSourceRoots(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(MavenProject p)
                                            throws DependencyResolutionRequiredException

Overrides:
getCompileClasspathElements in class AbstractFixJavadocMojo
Parameters:
p - not null
Returns:
the compile classpath elements
Throws:
DependencyResolutionRequiredException - if any

getArtifactType

protected String getArtifactType(MavenProject p)

Overrides:
getArtifactType in class AbstractFixJavadocMojo
Parameters:
p - not null maven project.
Returns:
the artifact type.

execute

public void execute()
             throws MojoExecutionException,
                    MojoFailureException

Specified by:
execute in interface Mojo
Overrides:
execute in class AbstractFixJavadocMojo
Throws:
MojoExecutionException
MojoFailureException


Copyright © 2004–2014 The Apache Software Foundation. All rights reserved.