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
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.java 617984 2008-02-03 13:02:51Z vsiveton $
- Author:
- Vincent Siveton
- See Also:
- Javadoc Tool,
Javadoc Options
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 |
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 |
TestJavadocReport
public TestJavadocReport()
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
- See Also:
MavenReport.getName(java.util.Locale)
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
- See Also:
MavenReport.getDescription(java.util.Locale)
getOutputName
public java.lang.String getOutputName()
- Specified by:
getOutputName
in interface org.apache.maven.reporting.MavenReport
- Overrides:
getOutputName
in class JavadocReport
- See Also:
JavadocReport.getOutputName()
getReportOutputDirectory
public java.io.File getReportOutputDirectory()
- Specified by:
getReportOutputDirectory
in interface org.apache.maven.reporting.MavenReport
- Overrides:
getReportOutputDirectory
in class JavadocReport
- See Also:
MavenReport.getReportOutputDirectory()
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
- a maven project
- Returns:
- the list of directories where compiled classes are placed for the given project. These dirs are
added in the javadoc classpath.
- See Also:
AbstractJavadocMojo.getProjectBuildOutputDirs(org.apache.maven.project.MavenProject)
getProjectSourceRoots
protected java.util.List getProjectSourceRoots(org.apache.maven.project.MavenProject p)
- Overrides:
getProjectSourceRoots
in class AbstractJavadocMojo
- Parameters:
p
- a maven project
- Returns:
- the list of source paths for the given project
- See Also:
AbstractJavadocMojo.getProjectSourceRoots(org.apache.maven.project.MavenProject)
getExecutionProjectSourceRoots
protected java.util.List getExecutionProjectSourceRoots(org.apache.maven.project.MavenProject p)
- Overrides:
getExecutionProjectSourceRoots
in class AbstractJavadocMojo
- Parameters:
p
- a maven project
- Returns:
- the list of source paths for the execution project of the given project
- See Also:
AbstractJavadocMojo.getExecutionProjectSourceRoots(org.apache.maven.project.MavenProject)
getProjectArtifacts
protected java.util.List getProjectArtifacts(org.apache.maven.project.MavenProject p)
- Overrides:
getProjectArtifacts
in class AbstractJavadocMojo
- Parameters:
p
- a maven project
- Returns:
- the list of artifacts for the given project
- See Also:
AbstractJavadocMojo.getProjectArtifacts(org.apache.maven.project.MavenProject)
getJavadocDirectory
protected java.io.File getJavadocDirectory()
- Overrides:
getJavadocDirectory
in class AbstractJavadocMojo
- Returns:
- the current javadoc directory
- See Also:
AbstractJavadocMojo.getJavadocDirectory()
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
- See Also:
AbstractJavadocMojo.getDoctitle()
getOverview
protected java.io.File getOverview()
- Overrides:
getOverview
in class AbstractJavadocMojo
- Returns:
- the overview documentation file from the user parameter or from the
javadocdirectory
- See Also:
AbstractJavadocMojo.getOverview()
getWindowtitle
protected java.lang.String getWindowtitle()
- Overrides:
getWindowtitle
in class AbstractJavadocMojo
- Returns:
- the title to be placed in the HTML title tag
- See Also:
AbstractJavadocMojo.getWindowtitle()
Copyright © 2004-2010 Apache Software Foundation. All Rights Reserved.