org.apache.maven.plugin.javadoc
Class JavadocReport

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
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 388169 2006-03-23 13:37:13Z brett $
Author:
Emmanuel Venisse, Vincent Siveton
See Also:
Javadoc Tool, Javadoc Options

Field Summary
 
Fields inherited from class org.apache.maven.plugin.javadoc.AbstractJavadocMojo
aggregate, outputDirectory, project
 
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()
           
protected  org.apache.maven.project.MavenProject getProject()
           
 java.io.File getReportOutputDirectory()
           
protected  org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()
           
 boolean isExternalReport()
           
 void setReportOutputDirectory(java.io.File reportOutputDirectory)
           
 
Methods inherited from class org.apache.maven.plugin.javadoc.AbstractJavadocMojo
canGenerateReport, executeReport, 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

JavadocReport

public JavadocReport()
Method Detail

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)

getProject

protected org.apache.maven.project.MavenProject getProject()
See Also:
AbstractMavenReport.getProject()

getSiteRenderer

protected org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()
See Also:
AbstractMavenReport.getSiteRenderer()

generate

public void generate(org.codehaus.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.codehaus.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

canGenerateReport

public boolean canGenerateReport()
Specified by:
canGenerateReport in interface org.apache.maven.reporting.MavenReport

getCategoryName

public java.lang.String getCategoryName()
Specified by:
getCategoryName in interface org.apache.maven.reporting.MavenReport

getReportOutputDirectory

public java.io.File getReportOutputDirectory()
Specified by:
getReportOutputDirectory in interface org.apache.maven.reporting.MavenReport

setReportOutputDirectory

public void setReportOutputDirectory(java.io.File reportOutputDirectory)
Specified by:
setReportOutputDirectory in interface org.apache.maven.reporting.MavenReport

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


Copyright © 2002-2007 Apache Software Foundation. All Rights Reserved.