Package org.apache.maven.tools.plugin.generator

Class PluginXdocGenerator

java.lang.Object

org.apache.maven.tools.plugin.generator.PluginXdocGenerator

All Implemented Interfaces:

Generator

public class PluginXdocGenerator
extends Object
implements Generator

Generate xdoc documentation for each mojo.

Constructor Summary

Constructors

Constructor	Description
PluginXdocGenerator()	Default constructor using Locale.ENGLISH as locale.
PluginXdocGenerator(org.apache.maven.project.MavenProject project)	Constructor using Locale.ENGLISH as locale.
PluginXdocGenerator(org.apache.maven.project.MavenProject project, Locale locale, File reportOutputDirectory, boolean disableInternalJavadocLinkValidation)

Method Summary

Modifier and Type	Method	Description
void	execute(File destinationDirectory, PluginToolsRequest request)	Execute the generation for a given plugin descriptor.
protected void	processMojoDescriptor(org.apache.maven.plugin.descriptor.MojoDescriptor mojoDescriptor, File destinationDirectory)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PluginXdocGenerator

public PluginXdocGenerator()

Default constructor using Locale.ENGLISH as locale. Used only in test cases.

PluginXdocGenerator

public PluginXdocGenerator(org.apache.maven.project.MavenProject project)

Constructor using Locale.ENGLISH as locale.

Parameters:

project - not null Maven project.

PluginXdocGenerator

public PluginXdocGenerator(org.apache.maven.project.MavenProject project,
 Locale locale,
 File reportOutputDirectory,
 boolean disableInternalJavadocLinkValidation)

Parameters:

project - not null.

locale - not null wanted locale.

Method Details

execute

public void execute(File destinationDirectory,
 PluginToolsRequest request)
             throws GeneratorException

Execute the generation for a given plugin descriptor.

Specified by:

execute in interface Generator

Parameters:

destinationDirectory - required

request - required

Throws:

GeneratorException - if any

processMojoDescriptor

protected void processMojoDescriptor(org.apache.maven.plugin.descriptor.MojoDescriptor mojoDescriptor,
 File destinationDirectory)
                              throws IOException

Parameters:

mojoDescriptor - not null

destinationDirectory - not null

Throws:

IOException - if any