org.apache.maven.plugin.javadoc
Class JavadocReport
java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.apache.maven.plugin.javadoc.AbstractJavadocMojo
org.apache.maven.plugin.javadoc.JavadocReport
- All Implemented Interfaces:
- org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenReport
public class JavadocReport
- extends AbstractJavadocMojo
- implements org.apache.maven.reporting.MavenReport
Generates documentation for the Java code in the project using the standard Javadoc Tool tool.
- Version:
- $Id: JavadocReport.java 480654 2006-11-29 17:39:51Z jvanzyl $
- Author:
- Emmanuel Venisse, 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 |
JavadocReport
public JavadocReport()
getName
public java.lang.String getName(java.util.Locale locale)
- Specified by:
getName
in interface org.apache.maven.reporting.MavenReport
- 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
- See Also:
MavenReport.getDescription(java.util.Locale)
generate
public void generate(org.apache.maven.doxia.sink.Sink sink,
java.util.Locale locale)
throws org.apache.maven.reporting.MavenReportException
- Specified by:
generate
in interface org.apache.maven.reporting.MavenReport
- Throws:
org.apache.maven.reporting.MavenReportException
- See Also:
MavenReport.generate(org.apache.maven.doxia.sink.Sink, java.util.Locale)
getOutputName
public java.lang.String getOutputName()
- Specified by:
getOutputName
in interface org.apache.maven.reporting.MavenReport
- See Also:
MavenReport.getOutputName()
isExternalReport
public boolean isExternalReport()
- Specified by:
isExternalReport
in interface org.apache.maven.reporting.MavenReport
- See Also:
MavenReport.isExternalReport()
canGenerateReport
public boolean canGenerateReport()
- Specified by:
canGenerateReport
in interface org.apache.maven.reporting.MavenReport
- See Also:
MavenReport.canGenerateReport()
getCategoryName
public java.lang.String getCategoryName()
- Specified by:
getCategoryName
in interface org.apache.maven.reporting.MavenReport
- See Also:
MavenReport.getCategoryName()
getReportOutputDirectory
public java.io.File getReportOutputDirectory()
- Specified by:
getReportOutputDirectory
in interface org.apache.maven.reporting.MavenReport
- 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
- Parameters:
reportOutputDirectory
- the directory file to be set
execute
public void execute()
throws org.apache.maven.plugin.MojoExecutionException,
org.apache.maven.plugin.MojoFailureException
- Specified by:
execute
in interface org.apache.maven.plugin.Mojo
- Throws:
org.apache.maven.plugin.MojoExecutionException
org.apache.maven.plugin.MojoFailureException
- See Also:
AbstractMavenReport.execute()
Copyright © 2002-2009 Apache Software Foundation. All Rights Reserved.