TestFixJavadocMojo (Apache Maven Javadoc Plugin 3.0.0 API)

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- org.apache.maven.plugin.AbstractMojo
- - org.apache.maven.plugins.javadoc.AbstractFixJavadocMojo
  - - org.apache.maven.plugins.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.java 1642248 2014-11-28 00:10:50Z hboutemy $

Author:

Vincent Siveton

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

Methods
Modifier and Type	Method and Description
`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.plugins.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

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

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