org.apache.maven.plugin.javadoc
Class TestJavadocReport

java.lang.Object
  extended by org.apache.maven.plugin.AbstractMojo
      extended by org.apache.maven.plugin.javadoc.AbstractJavadocMojo
          extended by org.apache.maven.plugin.javadoc.JavadocReport
              extended by 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 the project using the standard Javadoc Tool.

Since:
2.3
Version:
$Id: TestJavadocReport.html 829389 2012-08-19 17:23:07Z 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, failOnError, FILES_FILE_NAME, links, OPTIONS_FILE_NAME, outputDirectory, PACKAGES_FILE_NAME, project, skip, 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  void executeReport(java.util.Locale unusedLocale)
          The package documentation details the Javadoc Options used by this Plugin.
protected  java.util.List getCompileArtifacts(org.apache.maven.artifact.resolver.ArtifactResolutionResult result)
          
 java.lang.String getDescription(java.util.Locale locale)
          
protected  java.lang.String getDoctitle()
          
protected  java.util.List getExecutionProjectSourceRoots(org.apache.maven.project.MavenProject p)
          
protected  java.io.File getJavadocDirectory()
          
 java.lang.String getName(java.util.Locale locale)
          
 java.lang.String getOutputName()
          
protected  java.io.File getOverview()
          
protected  java.util.List getProjectArtifacts(org.apache.maven.project.MavenProject p)
          
protected  java.util.List getProjectBuildOutputDirs(org.apache.maven.project.MavenProject p)
          
protected  java.util.List getProjectSourceRoots(org.apache.maven.project.MavenProject p)
          
 java.io.File getReportOutputDirectory()
          
protected  java.lang.String getWindowtitle()
          
 void setReportOutputDirectory(java.io.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
canGenerateReport, getFiles, getOutputDirectory, 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(java.util.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 java.lang.String getName(java.util.Locale locale)

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)

Specified by:
getDescription in interface org.apache.maven.reporting.MavenReport
Overrides:
getDescription in class JavadocReport

getOutputName

public java.lang.String getOutputName()

Specified by:
getOutputName in interface org.apache.maven.reporting.MavenReport
Overrides:
getOutputName in class JavadocReport

getReportOutputDirectory

public java.io.File getReportOutputDirectory()

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

getProjectBuildOutputDirs

protected java.util.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 java.util.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 java.util.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 java.util.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 java.io.File getJavadocDirectory()

Overrides:
getJavadocDirectory in class AbstractJavadocMojo
Returns:
the current javadoc directory

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

getCompileArtifacts

protected java.util.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)


Copyright © 2004-2008 The Apache Software Foundation. All Rights Reserved.