org.apache.maven.plugin.javadoc
Class AbstractFixJavadocMojo
java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.apache.maven.plugin.javadoc.AbstractFixJavadocMojo
- All Implemented Interfaces:
- org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
- Direct Known Subclasses:
- FixJavadocMojo, TestFixJavadocMojo
public abstract class AbstractFixJavadocMojo
- extends org.apache.maven.plugin.AbstractMojo
Abstract class to fix Javadoc documentation and tags in source files.
See Where Tags Can Be Used.
- Since:
- 2.6
- Version:
- $Id$
- Author:
- Vincent Siveton
Field Summary |
protected boolean |
ignoreClirr
Flag to ignore or not Clirr. |
Fields inherited from interface org.apache.maven.plugin.Mojo |
ROLE |
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 |
ignoreClirr
protected boolean ignoreClirr
- Flag to ignore or not Clirr.
- Is defined by:
- expression:
- ${ignoreClirr}
- default-value:
- false
AbstractFixJavadocMojo
public AbstractFixJavadocMojo()
execute
public void execute()
throws org.apache.maven.plugin.MojoExecutionException,
org.apache.maven.plugin.MojoFailureException
-
- Throws:
org.apache.maven.plugin.MojoExecutionException
org.apache.maven.plugin.MojoFailureException
getArtifactType
protected String getArtifactType(org.apache.maven.project.MavenProject p)
- Parameters:
p
- not null maven project.
- Returns:
- the artifact type.
getProjectSourceRoots
protected List<String> getProjectSourceRoots(org.apache.maven.project.MavenProject p)
- Parameters:
p
- not null maven project.
- Returns:
- the list of source paths for the given project.
getCompileClasspathElements
protected List<String> getCompileClasspathElements(org.apache.maven.project.MavenProject p)
throws org.apache.maven.artifact.DependencyResolutionRequiredException
- Parameters:
p
- not null
- Returns:
- the compile classpath elements
- Throws:
org.apache.maven.artifact.DependencyResolutionRequiredException
- if any
getJavaMethodAsString
protected static String getJavaMethodAsString(com.thoughtworks.qdox.model.JavaMethod javaMethod)
- Parameters:
javaMethod
- not null
- Returns:
- the fully qualify name of javaMethod with signature
Copyright © 2004-2011 The Apache Software Foundation. All Rights Reserved.