org.apache.maven.plugin.javadoc

Class JavadocReport

public class JavadocReport extends AbstractJavadocMojo implements 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

UNKNOWN: javadoc generate-sources

Method Summary
booleancanGenerateReport()
voidexecute()
voidgenerate(Sink sink, Locale locale)
StringgetCategoryName()
StringgetDescription(Locale locale)
StringgetName(Locale locale)
StringgetOutputName()
protected MavenProjectgetProject()
FilegetReportOutputDirectory()
protected RenderergetSiteRenderer()
booleanisExternalReport()
voidsetReportOutputDirectory(File reportOutputDirectory)

Method Detail

canGenerateReport

public boolean canGenerateReport()

execute

public void execute()

generate

public void generate(Sink sink, Locale locale)

See Also: org.apache.maven.reporting.MavenReport#generate(org.codehaus.doxia.sink.Sink, java.util.Locale)

getCategoryName

public String getCategoryName()

getDescription

public String getDescription(Locale locale)

See Also: org.apache.maven.reporting.MavenReport#getDescription(java.util.Locale)

getName

public String getName(Locale locale)

See Also: org.apache.maven.reporting.MavenReport#getName(java.util.Locale)

getOutputName

public String getOutputName()

See Also: org.apache.maven.reporting.MavenReport#getOutputName()

getProject

protected MavenProject getProject()

See Also: org.apache.maven.reporting.AbstractMavenReport#getProject()

getReportOutputDirectory

public File getReportOutputDirectory()

getSiteRenderer

protected Renderer getSiteRenderer()

See Also: org.apache.maven.reporting.AbstractMavenReport#getSiteRenderer()

isExternalReport

public boolean isExternalReport()

setReportOutputDirectory

public void setReportOutputDirectory(File reportOutputDirectory)
Copyright © 2002-2007 Apache Software Foundation. All Rights Reserved.