PluginXdocGenerator (Maven Plugin Tools 3.4 API)

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.

Version:

$Id: PluginXdocGenerator.html 934731 2015-01-01 22:17:21Z hboutemy $

Constructor Summary

Constructors
Constructor and 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)`

Method Summary

Methods
Modifier and Type	Method and 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 Detail
- 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)
```
  Parameters:
  project - not null.
  locale - not null wanted locale.

Method Detail

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

Class PluginXdocGenerator

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PluginXdocGenerator

PluginXdocGenerator

PluginXdocGenerator

Method Detail

execute

processMojoDescriptor