|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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
public class TestJavadocReport
Generates documentation for the Java Test code
in an NON aggregator project using the standard
Javadoc Tool.
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 |
---|
public TestJavadocReport()
Method Detail |
---|
protected void executeReport(Locale unusedLocale) throws org.apache.maven.reporting.MavenReportException
executeReport
in class AbstractJavadocMojo
unusedLocale
- the wanted locale (actually unused).
org.apache.maven.reporting.MavenReportException
- if anypublic String getName(Locale locale)
getName
in interface org.apache.maven.reporting.MavenReport
getName
in class JavadocReport
public String getDescription(Locale locale)
getDescription
in interface org.apache.maven.reporting.MavenReport
getDescription
in class JavadocReport
public String getOutputName()
getOutputName
in interface org.apache.maven.reporting.MavenReport
getOutputName
in class JavadocReport
public File getReportOutputDirectory()
getReportOutputDirectory
in interface org.apache.maven.reporting.MavenReport
getReportOutputDirectory
in class JavadocReport
public void setReportOutputDirectory(File reportOutputDirectory)
setReportOutputDirectory
in interface org.apache.maven.reporting.MavenReport
setReportOutputDirectory
in class JavadocReport
reportOutputDirectory
- the directory file to be setpublic void setDestDir(String destDir)
setDestDir
in class JavadocReport
protected List getProjectBuildOutputDirs(org.apache.maven.project.MavenProject p)
getProjectBuildOutputDirs
in class AbstractJavadocMojo
p
- not null maven project
protected List getProjectSourceRoots(org.apache.maven.project.MavenProject p)
getProjectSourceRoots
in class AbstractJavadocMojo
p
- not null maven project
protected List getExecutionProjectSourceRoots(org.apache.maven.project.MavenProject p)
getExecutionProjectSourceRoots
in class AbstractJavadocMojo
p
- not null maven project
protected List getProjectArtifacts(org.apache.maven.project.MavenProject p)
getProjectArtifacts
in class AbstractJavadocMojo
p
- not null maven project
protected File getJavadocDirectory()
getJavadocDirectory
in class AbstractJavadocMojo
protected String getDoctitle()
getDoctitle
in class AbstractJavadocMojo
protected File getOverview()
getOverview
in class AbstractJavadocMojo
javadocdirectory
protected String getWindowtitle()
getWindowtitle
in class AbstractJavadocMojo
protected List getCompileArtifacts(org.apache.maven.artifact.resolver.ArtifactResolutionResult result)
getCompileArtifacts
in class AbstractJavadocMojo
result
- not null
JavadocUtil.getCompileArtifacts(Set, boolean)
protected SourceResolverConfig configureDependencySourceResolution(SourceResolverConfig config)
configureDependencySourceResolution
in class AbstractJavadocMojo
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |