de.smartics.maven.apidoc
Class ApiDocReportMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.maven.reporting.AbstractMavenReport
          de.smartics.maven.apidoc.AbstractReportMojo
              de.smartics.maven.apidoc.ApiDocReportMojo

All Implemented Interfaces:

ContextEnabled, Mojo, MavenReport

public class ApiDocReportMojo
     
     

      
      extends 
      
      AbstractReportMojo
     
     

API doc report.

Author:

Robert Reiner

maven-goal:

apidoc-report

maven-phase:

site

maven-requiresProject:

maven-description:

Generates a report on Javadoc comments.

Field Summary

protected List<org.apache.maven.artifact.Artifact>

pluginArtifacts The plugin's dependencies to build the classpath for tools to be called.

Fields inherited from class de.smartics.maven.apidoc.AbstractReportMojo

factory, locale, localRepository, logLevel, outputDirectory, project, resolver, siteRenderer, skip

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

ApiDocReportMojo()

Method Summary

protected void	executeReport(Locale locale) Configures the plugin logger.
String	getDescription(Locale locale)
String	getName(Locale locale)
String	getOutputName()

Methods inherited from class de.smartics.maven.apidoc.AbstractReportMojo

canGenerateReport, execute, getBundle, getOutputDirectory, getProject, getSiteRenderer, provideSink

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

closeReport, generate, getCategoryName, getReportOutputDirectory, getSink, isExternalReport, 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

Field Detail

pluginArtifacts

protected List<org.apache.maven.artifact.Artifact> pluginArtifacts

The plugin's dependencies to build the classpath for tools to be called.

Since:

1.0

Constructor Detail

ApiDocReportMojo

public ApiDocReportMojo()

Method Detail

getName

public String getName(Locale locale)

See Also:

MavenReport.getName(java.util.Locale)

getDescription

public String getDescription(Locale locale)

See Also:

MavenReport.getDescription(java.util.Locale)

getOutputName

public String getOutputName()

See Also:

MavenReport.getOutputName()

executeReport

protected void executeReport(Locale locale)
                      throws MavenReportException

Configures the plugin logger.

Overrides:

executeReport in class AbstractReportMojo

Throws:

MavenReportException

See Also:

AbstractMavenReport.executeReport(java.util.Locale)