org.apache.maven.plugin.plugin

Class XdocGeneratorMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugin.plugin.AbstractGeneratorMojo

org.apache.maven.plugin.plugin.XdocGeneratorMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="xdoc",
      threadSafe=true)
public class XdocGeneratorMojo
extends AbstractGeneratorMojo

Generate Xdoc files for the project mojos or goals.

Since:

2.0

Version:

$Id: XdocGeneratorMojo.java 1345787 2012-06-03 21:58:22Z hboutemy $

Author:

Brett Porter

Field Summary

Fields

Modifier and Type	Field and Description
protected File	outputDirectory The directory where the generated Xdoc files will be put.

Fields inherited from class org.apache.maven.plugin.plugin.AbstractGeneratorMojo

dependencies, encoding, extractors, goalPrefix, local, mojoScanner, project, remoteRepos, skip, skipErrorNoDescriptorsFound

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
XdocGeneratorMojo()

Method Summary

Modifier and Type	Method and Description
protected org.apache.maven.tools.plugin.generator.Generator	createGenerator()
protected File	getOutputDirectory()

Methods inherited from class org.apache.maven.plugin.plugin.AbstractGeneratorMojo

execute

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.build.directory}/generated-site/xdoc")
protected File outputDirectory

The directory where the generated Xdoc files will be put.

Constructor Detail

XdocGeneratorMojo

public XdocGeneratorMojo()

Method Detail

getOutputDirectory

protected File getOutputDirectory()

Specified by:

getOutputDirectory in class AbstractGeneratorMojo

Returns:

the output directory where files will be generated.

createGenerator

protected org.apache.maven.tools.plugin.generator.Generator createGenerator()

Specified by:

createGenerator in class AbstractGeneratorMojo

Returns:

the wanted Generator implementation.