eu.lindenbaum.maven.report
Class EDocReport

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.maven.reporting.AbstractMavenReport
          eu.lindenbaum.maven.ErlangReport
              eu.lindenbaum.maven.report.EDocReport

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenMultiPageReport, org.apache.maven.reporting.MavenReport

public class EDocReport
extends ErlangReport

This Mojo will generate source code documentation for an application.

Author:

Tobias Schlager

Goal:

edoc

Execute:

phase="generate-resources"

Field Summary

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

EDocReport()

Method Summary

protected void	execute(org.apache.maven.plugin.logging.Log log, Locale l, Properties p) Will be invoked when AbstractMavenReport.execute() gets invoked on the base class.
String	getDescription(Locale locale)
String	getName(Locale locale)
String	getOutputName()
boolean	isExternalReport()

Methods inherited from class eu.lindenbaum.maven.ErlangReport

canGenerateReport, executeReport, getOutputDirectory, getProject, getProperties, getSiteRenderer

Methods inherited from class org.apache.maven.reporting.AbstractMavenReport

closeReport, execute, generate, generate, generate, getCategoryName, getReportOutputDirectory, getSink, getSinkFactory, setReportOutputDirectory

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

EDocReport

public EDocReport()

Method Detail

getOutputName

public String getOutputName()

getName

public String getName(Locale locale)

getDescription

public String getDescription(Locale locale)

isExternalReport

public boolean isExternalReport()

Specified by:

isExternalReport in interface org.apache.maven.reporting.MavenReport

Overrides:

isExternalReport in class org.apache.maven.reporting.AbstractMavenReport

execute

protected void execute(org.apache.maven.plugin.logging.Log log,
                       Locale l,
                       Properties p)
                throws org.apache.maven.plugin.MojoExecutionException

Description copied from class: ErlangReport

Will be invoked when AbstractMavenReport.execute() gets invoked on the base class.

Specified by:

execute in class ErlangReport

Parameters:

log - logger to be used for output logging

l - the demanded locale as passed to ErlangReport.executeReport(Locale)

p - to be passed by the base class.

Throws:

org.apache.maven.plugin.MojoExecutionException

See Also:

AbstractMavenReport.executeReport(Locale)