org.apache.maven.plugin.javadoc
Class TestJavadocReport

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.maven.plugin.javadoc.AbstractJavadocMojo
          org.apache.maven.plugin.javadoc.JavadocReport
              org.apache.maven.plugin.javadoc.TestJavadocReport

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenReport

Direct Known Subclasses:

AggregatorTestJavadocReport

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.html 829396 2012-08-19 17:35:19Z hboutemy $

Author:

Vincent Siveton

See Also:

Javadoc Tool, Javadoc Options

Is defined to be executed in:

phase:

generate-test-sources

Is defined by the goal name:

test-javadoc

Requires the dependencies in this specified scope:

test

Field Summary

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

aggregate, 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, 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

TestJavadocReport()

Method Summary

protected SourceResolverConfig	configureDependencySourceResolution(SourceResolverConfig config) Overriden 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 List	getCompileArtifacts(org.apache.maven.artifact.resolver.ArtifactResolutionResult result)
String	getDescription(Locale locale)
protected String	getDoctitle()
protected List	getExecutionProjectSourceRoots(org.apache.maven.project.MavenProject p)
protected File	getJavadocDirectory()
String	getName(Locale locale)
String	getOutputName()
protected File	getOverview()
protected List	getProjectArtifacts(org.apache.maven.project.MavenProject p)
protected List	getProjectBuildOutputDirs(org.apache.maven.project.MavenProject p)
protected List	getProjectSourceRoots(org.apache.maven.project.MavenProject p)
File	getReportOutputDirectory()
protected String	getWindowtitle()
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.plugin.javadoc.JavadocReport

canGenerateReport, execute, generate, getCategoryName, isAggregator, isExternalReport

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

buildJavadocOptions, canGenerateReport, getAttachmentClassifier, getDependencySourcePaths, getFiles, getJavadocOptionsFile, getOutputDirectory, getProject, getSourcePaths

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

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)

Specified by:

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

Overrides:

getName in class JavadocReport

getDescription

public String getDescription(Locale locale)

Specified by:

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

Overrides:

getDescription in class JavadocReport

getOutputName

public String getOutputName()

Specified by:

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

Overrides:

getOutputName in class JavadocReport

getReportOutputDirectory

public File getReportOutputDirectory()

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

getProjectBuildOutputDirs

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

getProjectArtifacts

protected List getProjectArtifacts(org.apache.maven.project.MavenProject p)

Overrides:

getProjectArtifacts in class AbstractJavadocMojo

Parameters:

p - not null maven project

Returns:

the list of artifacts for 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

getCompileArtifacts

protected List getCompileArtifacts(org.apache.maven.artifact.resolver.ArtifactResolutionResult result)

Overrides:

getCompileArtifacts in class AbstractJavadocMojo

Parameters:

result - not null

Returns:

the compile artifacts from the result

See Also:

JavadocUtil.getCompileArtifacts(Set, boolean)

configureDependencySourceResolution

protected SourceResolverConfig configureDependencySourceResolution(SourceResolverConfig config)

Overriden 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