|
||||||||||
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
public class JavadocReport
Generates documentation for the Java code
in the 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, 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 | |
---|---|
JavadocReport()
|
Method Summary | |
---|---|
boolean |
canGenerateReport()
|
void |
execute()
|
void |
generate(org.codehaus.doxia.sink.Sink sink,
java.util.Locale locale)
|
java.lang.String |
getCategoryName()
|
java.lang.String |
getDescription(java.util.Locale locale)
|
java.lang.String |
getName(java.util.Locale locale)
|
java.lang.String |
getOutputName()
|
java.io.File |
getReportOutputDirectory()
|
protected boolean |
isAggregator()
Indicates whether this goal is flagged with @aggregator . |
boolean |
isExternalReport()
|
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.AbstractJavadocMojo |
---|
canGenerateReport, executeReport, getCompileArtifacts, getDoctitle, getExecutionProjectSourceRoots, getFiles, getJavadocDirectory, getOutputDirectory, getOverview, getProjectArtifacts, getProjectBuildOutputDirs, getProjectSourceRoots, getSourcePaths, getWindowtitle |
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 JavadocReport()
Method Detail |
---|
public java.lang.String getName(java.util.Locale locale)
getName
in interface org.apache.maven.reporting.MavenReport
public java.lang.String getDescription(java.util.Locale locale)
getDescription
in interface org.apache.maven.reporting.MavenReport
public void generate(org.codehaus.doxia.sink.Sink sink, java.util.Locale locale) throws org.apache.maven.reporting.MavenReportException
generate
in interface org.apache.maven.reporting.MavenReport
org.apache.maven.reporting.MavenReportException
public java.lang.String getOutputName()
getOutputName
in interface org.apache.maven.reporting.MavenReport
public boolean isExternalReport()
isExternalReport
in interface org.apache.maven.reporting.MavenReport
public boolean canGenerateReport()
canGenerateReport
in interface org.apache.maven.reporting.MavenReport
public java.lang.String getCategoryName()
getCategoryName
in interface org.apache.maven.reporting.MavenReport
public java.io.File getReportOutputDirectory()
getReportOutputDirectory
in interface org.apache.maven.reporting.MavenReport
public void setReportOutputDirectory(java.io.File reportOutputDirectory)
setReportOutputDirectory
in interface org.apache.maven.reporting.MavenReport
reportOutputDirectory
- the directory file to be setpublic void execute() throws org.apache.maven.plugin.MojoExecutionException, org.apache.maven.plugin.MojoFailureException
execute
in interface org.apache.maven.plugin.Mojo
org.apache.maven.plugin.MojoExecutionException
org.apache.maven.plugin.MojoFailureException
protected boolean isAggregator()
@aggregator
.
isAggregator
in class AbstractJavadocMojo
true
if the goal is designed as an aggregator, false
otherwise.AggregatorJavadocReport
,
AggregatorTestJavadocReport
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |