org.apache.maven.plugins.javadoc

Class AbstractFixJavadocMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugins.javadoc.AbstractFixJavadocMojo

All Implemented Interfaces:

ContextEnabled, Mojo

Direct Known Subclasses:

FixJavadocMojo, TestFixJavadocMojo

public abstract class AbstractFixJavadocMojo
extends AbstractMojo

Abstract class to fix Javadoc documentation and tags in source files.
See Where Tags Can Be Used.

Since:

2.6

Version:

$Id: AbstractFixJavadocMojo.java 1801354 2017-07-09 08:49:46Z rfscholte $

Author:

Vincent Siveton

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_VERSION_VALUE Default version value.
protected boolean	ignoreClirr Flag to ignore or not Clirr.
static String	JAVA_FILES Java Files Pattern.

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractFixJavadocMojo()

Method Summary

Modifier and Type	Method and Description
void	execute()
protected String	getArtifactType(MavenProject p)
protected List<String>	getCompileClasspathElements(MavenProject p)
protected static String	getJavaMethodAsString(com.thoughtworks.qdox.model.JavaExecutable javaExecutable)
protected List<String>	getProjectSourceRoots(MavenProject p)

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

Field Detail

JAVA_FILES

public static final String JAVA_FILES

Java Files Pattern.

See Also:

Constant Field Values

DEFAULT_VERSION_VALUE

public static final String DEFAULT_VERSION_VALUE

Default version value.

See Also:

Constant Field Values

ignoreClirr

@Parameter(property="ignoreClirr",
           defaultValue="false")
protected boolean ignoreClirr

Flag to ignore or not Clirr.

Constructor Detail

AbstractFixJavadocMojo

public AbstractFixJavadocMojo()

Method Detail

execute

public void execute()
             throws MojoExecutionException,
                    MojoFailureException

Throws:

MojoExecutionException

MojoFailureException

getArtifactType

protected String getArtifactType(MavenProject p)

Parameters:

p - not null maven project.

Returns:

the artifact type.

getProjectSourceRoots

protected List<String> getProjectSourceRoots(MavenProject p)

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

Parameters:

p - not null

Returns:

the compile classpath elements

Throws:

DependencyResolutionRequiredException - if any

getJavaMethodAsString

protected static String getJavaMethodAsString(com.thoughtworks.qdox.model.JavaExecutable javaExecutable)

Parameters:

javaExecutable - not null

Returns:

the fully qualify name of javaMethod with signature