org.apache.maven.plugin.javadoc
Class AbstractFixJavadocMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.maven.plugin.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.html 829400 2012-08-19 17:42:28Z hboutemy $

Author:

Vincent Siveton

Field Summary

protected boolean

ignoreClirr Flag to ignore or not Clirr.

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

ROLE

Constructor Summary

AbstractFixJavadocMojo()

Method Summary

void	execute()
protected String	getArtifactType(MavenProject p)
protected List<String>	getCompileClasspathElements(MavenProject p)
protected static String	getJavaMethodAsString(JavaMethod javaMethod)
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

ignoreClirr

protected boolean ignoreClirr

Flag to ignore or not Clirr.

Is defined by:

expression:

${ignoreClirr}

default-value:

false

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(JavaMethod javaMethod)

Parameters:

javaMethod - not null

Returns:

the fully qualify name of javaMethod with signature