Package org.apache.maven.plugins.javadoc

Class TestJavadocReport

  • All Implemented Interfaces:
    org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenReport
    Direct Known Subclasses:
    AggregatorTestJavadocReport, TestJavadocNoForkReport
    @Mojo(name="test-javadoc",
      requiresDependencyResolution=TEST,
      threadSafe=true)
@Execute(phase=GENERATE_TEST_SOURCES)
public class TestJavadocReport
extends JavadocReport
    Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool.
    Since:
    2.3
    Version:
    $Id: TestJavadocReport.java 1747985 2016-06-12 12:04:55Z rfscholte $
    Author:
    Vincent Siveton
    See Also:
    Javadoc Tool, Javadoc Options

    • Constructor Detail

      • TestJavadocReport

        public TestJavadocReport()

    • Method Detail

      • executeReport

        protected void executeReport​(java.util.Locale unusedLocale)
                      throws org.apache.maven.reporting.MavenReportException
        Description copied from class: AbstractJavadocMojo
        The package documentation details the Javadoc Options used by this Plugin.
        Overrides:
        executeReport in class AbstractJavadocMojo
        Parameters:
        unusedLocale - the wanted locale (actually unused).
        Throws:
        org.apache.maven.reporting.MavenReportException - if any

      • getName

        public java.lang.String getName​(java.util.Locale locale)
        Description copied from class: JavadocReport
        Specified by:
        getName in interface org.apache.maven.reporting.MavenReport
        Overrides:
        getName in class JavadocReport

      • getDescription

        public java.lang.String getDescription​(java.util.Locale locale)
        Description copied from class: JavadocReport
        Specified by:
        getDescription in interface org.apache.maven.reporting.MavenReport
        Overrides:
        getDescription in class JavadocReport

      • getOutputName

        public java.lang.String getOutputName()
        Description copied from class: JavadocReport
        Specified by:
        getOutputName in interface org.apache.maven.reporting.MavenReport
        Overrides:
        getOutputName in class JavadocReport

      • getReportOutputDirectory

        public java.io.File getReportOutputDirectory()
        Description copied from class: JavadocReport
        Specified by:
        getReportOutputDirectory in interface org.apache.maven.reporting.MavenReport
        Overrides:
        getReportOutputDirectory in class JavadocReport

      • setReportOutputDirectory

        public void setReportOutputDirectory​(java.io.File reportOutputDirectory)
        Method to set the directory where the generated reports will be put
        Specified by:
        setReportOutputDirectory in interface org.apache.maven.reporting.MavenReport
        Overrides:
        setReportOutputDirectory in class JavadocReport
        Parameters:
        reportOutputDirectory - the directory file to be set

      • setDestDir

        public void setDestDir​(java.lang.String destDir)
        Overrides:
        setDestDir in class JavadocReport
        Parameters:
        destDir - The destiation directory.

      • getProjectBuildOutputDirs

        protected java.util.List<java.io.File> getProjectBuildOutputDirs​(org.apache.maven.project.MavenProject p)
        Overrides:
        getProjectBuildOutputDirs in class AbstractJavadocMojo
        Parameters:
        p - not null maven project
        Returns:
        the list of directories where compiled classes are placed for the given project. These dirs are added in the javadoc classpath.

      • getProjectSourceRoots

        protected java.util.List<java.lang.String> getProjectSourceRoots​(org.apache.maven.project.MavenProject p)
        Overrides:
        getProjectSourceRoots in class AbstractJavadocMojo
        Parameters:
        p - not null maven project
        Returns:
        the list of source paths for the given project

      • getExecutionProjectSourceRoots

        protected java.util.List<java.lang.String> getExecutionProjectSourceRoots​(org.apache.maven.project.MavenProject p)
        Overrides:
        getExecutionProjectSourceRoots in class AbstractJavadocMojo
        Parameters:
        p - not null maven project
        Returns:
        the list of source paths for the execution project of the given project

      • getDoctitle

        protected java.lang.String getDoctitle()
        Overrides:
        getDoctitle in class AbstractJavadocMojo
        Returns:
        the title to be placed near the top of the overview summary file

      • getOverview

        protected java.io.File getOverview()
        Overrides:
        getOverview in class AbstractJavadocMojo
        Returns:
        the overview documentation file from the user parameter or from the javadocdirectory

      • getWindowtitle

        protected java.lang.String getWindowtitle()
        Overrides:
        getWindowtitle in class AbstractJavadocMojo
        Returns:
        the title to be placed in the HTML title tag

      • isTest

        protected boolean isTest()
        Description copied from class: AbstractJavadocMojo
        Indicates whether this goal generates documentation for the Java Test code.
        Overrides:
        isTest in class AbstractJavadocMojo
        Returns:
        true if the goal generates Test Javadocs, false otherwise.