org.apache.maven.plugins.javadoc

Class TestJavadocReport

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugins.javadoc.AbstractJavadocMojo

org.apache.maven.plugins.javadoc.JavadocReport

org.apache.maven.plugins.javadoc.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

Field Summary

Fields inherited from class org.apache.maven.plugins.javadoc.AbstractJavadocMojo

ARGFILE_FILE_NAME, DEBUG_JAVADOC_SCRIPT_NAME, DEFAULT_JAVA_API_LINKS, failOnError, FILES_FILE_NAME, JAVADOC_RESOURCES_ATTACHMENT_CLASSIFIER, links, OPTIONS_FILE_NAME, outputDirectory, PACKAGES_FILE_NAME, project, session, skip, TEST_JAVADOC_RESOURCES_ATTACHMENT_CLASSIFIER, useStandardDocletOptions

Fields inherited from interface org.apache.maven.reporting.MavenReport

CATEGORY_PROJECT_INFORMATION, CATEGORY_PROJECT_REPORTS, ROLE

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

ROLE

Constructor Summary

Constructors

Constructor and Description
TestJavadocReport()

Method Summary

Methods

Modifier and Type	Method and Description
protected SourceResolverConfig	configureDependencySourceResolution(SourceResolverConfig config) Overridden to enable the resolution of -test-sources jar files.
protected void	executeReport(Locale unusedLocale) The package documentation details the Javadoc Options used by this Plugin.
protected org.apache.maven.shared.artifact.filter.resolve.ScopeFilter	getDependencyScopeFilter()
String	getDescription(Locale locale)
protected String	getDoctitle()
protected List<String>	getExecutionProjectSourceRoots(org.apache.maven.project.MavenProject p)
protected File	getJavadocDirectory()
String	getName(Locale locale)
String	getOutputName()
protected File	getOverview()
protected List<File>	getProjectBuildOutputDirs(org.apache.maven.project.MavenProject p)
protected List<String>	getProjectSourceRoots(org.apache.maven.project.MavenProject p)
File	getReportOutputDirectory()
protected String	getWindowtitle()
protected boolean	isTest() Indicates whether this goal generates documentation for the Java Test code.
void	setDestDir(String destDir)
void	setReportOutputDirectory(File reportOutputDirectory) Method to set the directory where the generated reports will be put

Methods inherited from class org.apache.maven.plugins.javadoc.JavadocReport

canGenerateReport, doExecute, generate, getCategoryName, isExternalReport

Methods inherited from class org.apache.maven.plugins.javadoc.AbstractJavadocMojo

buildJavadocOptions, canGenerateReport, collect, execute, failOnError, getAttachmentClassifier, getDependencySourcePaths, getDoclint, getFiles, getJavadocOptionsFile, getOutputDirectory, getProject, getSourcePaths, getToolchain, isAggregator, isValidJavadocLink, logError, resolveDependency, verifyRemovedParameter

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

Constructor Detail

TestJavadocReport

public TestJavadocReport()

Method Detail

executeReport

protected void executeReport(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 String getName(Locale locale)

Description copied from class: JavadocReport

Specified by:

getName in interface org.apache.maven.reporting.MavenReport

Overrides:

getName in class JavadocReport

getDescription

public String getDescription(Locale locale)

Description copied from class: JavadocReport

Specified by:

getDescription in interface org.apache.maven.reporting.MavenReport

Overrides:

getDescription in class JavadocReport

getOutputName

public String getOutputName()

Description copied from class: JavadocReport

Specified by:

getOutputName in interface org.apache.maven.reporting.MavenReport

Overrides:

getOutputName in class JavadocReport

getReportOutputDirectory

public 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(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(String destDir)

Overrides:

setDestDir in class JavadocReport

Parameters:

destDir - The destiation directory.

getProjectBuildOutputDirs

protected List<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 List<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 List<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

getJavadocDirectory

protected File getJavadocDirectory()

Overrides:

getJavadocDirectory in class AbstractJavadocMojo

Returns:

the current javadoc directory

getDoctitle

protected String getDoctitle()

Overrides:

getDoctitle in class AbstractJavadocMojo

Returns:

the title to be placed near the top of the overview summary file

getOverview

protected File getOverview()

Overrides:

getOverview in class AbstractJavadocMojo

Returns:

the overview documentation file from the user parameter or from the javadocdirectory

getWindowtitle

protected String getWindowtitle()

Overrides:

getWindowtitle in class AbstractJavadocMojo

Returns:

the title to be placed in the HTML title tag

getDependencyScopeFilter

protected org.apache.maven.shared.artifact.filter.resolve.ScopeFilter getDependencyScopeFilter()

Overrides:

getDependencyScopeFilter in class AbstractJavadocMojo

configureDependencySourceResolution

protected SourceResolverConfig configureDependencySourceResolution(SourceResolverConfig config)

Overridden to enable the resolution of -test-sources jar files. Override this method to customize the configuration for resolving dependency sources. The default behavior enables the resolution of -sources jar files.

Overrides:

configureDependencySourceResolution in class AbstractJavadocMojo

Parameters:

config -

Returns:

SourceResolverConfig

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.