org.codehaus.mojo.servicedocgen

Class ServiceDocGenReport

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.reporting.AbstractMavenReport

org.codehaus.mojo.servicedocgen.ServiceDocGenReport

All Implemented Interfaces:

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

@Mojo(name="generate",
      defaultPhase=PREPARE_PACKAGE,
      requiresProject=true,
      requiresDirectInvocation=false,
      executionStrategy="once-per-session",
      requiresDependencyResolution=COMPILE_PLUS_RUNTIME,
      requiresDependencyCollection=COMPILE_PLUS_RUNTIME)
public class ServiceDocGenReport
extends org.apache.maven.reporting.AbstractMavenReport

Maven Plugin to automatically generate documentation for services of the current project.

1. Scans the current projects source code for (JAX-RS annotated) services that match the RegEx configured by classnameRegex.
2. Analyzes the services from source-code (extract JavaDoc, etc.) and byte-code (resolve generic parameters, etc.) and create intermediate meta-data as ServicesDescriptor.
3. Generates documentation from the collected meta-data (by default as HTML from a velocity template shipped with this plugin but can be overridden via configuration parameters).

scan and analyze services from the current project via source-code and byte-code analysis. Creates

Author:

hohwille

Field Summary

Fields

Modifier and Type	Field and Description
protected File	outputDirectory

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

project, siteRenderer

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

Constructors

Constructor and Description
ServiceDocGenReport()

Method Summary

Modifier and Type	Method and Description
boolean	canGenerateReport()
void	execute()
protected void	executeReport(Locale locale)
protected ResourceBundle	getBundle(Locale locale)
String	getDescription(Locale locale)
String	getName(Locale locale)
protected String	getOutputDirectoryPath()
String	getOutputName()
boolean	isExternalReport()

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

closeReport, generate, generate, generate, getCategoryName, getInputEncoding, getOutputDirectory, getOutputEncoding, getProject, getReportOutputDirectory, getSink, getSinkFactory, getSiteRenderer, 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

outputDirectory

@Parameter(defaultValue="${project.reporting.outputDirectory}",
           readonly=true,
           required=true)
protected File outputDirectory

Constructor Detail

ServiceDocGenReport

public ServiceDocGenReport()

Method Detail

getOutputName

public String getOutputName()

getBundle

protected ResourceBundle getBundle(Locale locale)

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

getOutputDirectoryPath

protected String getOutputDirectoryPath()

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Overrides:

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

Throws:

org.apache.maven.plugin.MojoExecutionException

canGenerateReport

public boolean canGenerateReport()

Specified by:

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

Overrides:

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

executeReport

protected void executeReport(Locale locale)
                      throws org.apache.maven.reporting.MavenReportException

Specified by:

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

Throws:

org.apache.maven.reporting.MavenReportException