Package org.apache.maven.plugins.javadoc

Class AbstractFixJavadocMojo

java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.apache.maven.plugins.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.
Since:
2.6
Author:
Vincent Siveton
See Also:

  • Field Details

    • JAVA_FILES

      public static final String JAVA_FILES
      Java Files Pattern.
      See Also:

    • ignoreClirr

      @Parameter(property="ignoreClirr", defaultValue="false") protected boolean ignoreClirr
      Flag to ignore or not Clirr.

  • Constructor Details

    • AbstractFixJavadocMojo

      public AbstractFixJavadocMojo(org.codehaus.plexus.components.interactivity.InputHandler inputHandler)

  • Method Details

    • 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

    • getProject

      protected final org.apache.maven.project.MavenProject getProject()

    • 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.JavaExecutable javaExecutable)
      Parameters:
      javaExecutable - not null
      Returns:
      the fully qualify name of javaMethod with signature