Package org.codehaus.modello.maven

Class ModelloXdocMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.codehaus.modello.maven.AbstractModelloGeneratorMojo

org.codehaus.modello.maven.ModelloXdocMojo

All Implemented Interfaces:

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

@Mojo(name="xdoc",
      threadSafe=true)
public class ModelloXdocMojo
extends AbstractModelloGeneratorMojo

Creates documentation for the model in xdoc format.

Field Summary

Fields

Modifier and Type	Field	Description
private String	firstVersion	The first version of the model.
private File	outputDirectory	The output directory of the generated documentation.
private String	xdocFileName

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

ROLE

Constructor Summary

Constructors

Constructor	Description
ModelloXdocMojo()

Method Summary

Modifier and Type	Method	Description
protected void	customizeParameters(Properties parameters)	Override this method to customize the values in the properties set.
String	getFirstVersion()
protected String	getGeneratorType()
File	getOutputDirectory()
protected boolean	producesCompilableResult()
void	setFirstVersion(String firstVersion)
void	setOutputDirectory(File outputDirectory)

Methods inherited from class org.codehaus.modello.maven.AbstractModelloGeneratorMojo

createParameters, execute, getBasedir, getModelloCore, getModels, getPackageWithVersion, getProject, getVersion, producesResources, setBasedir, setBuildContext, setModelloCore, setModels, setPackagedVersions, setPackageWithVersion, setProject, setVersion

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 Details

outputDirectory

@Parameter(defaultValue="${project.build.directory}/generated-site/xdoc",
           required=true)
private File outputDirectory

The output directory of the generated documentation.

xdocFileName

@Parameter
private String xdocFileName

Since:

1.0-alpha-21

firstVersion

@Parameter
private String firstVersion

The first version of the model. This is used to decide whether or not to show the since column. If this is not specified, it defaults to the version of the model, which in turn means that the since column will not be shown.

Since:

1.0-alpha-14

Constructor Details

ModelloXdocMojo

public ModelloXdocMojo()

Method Details

getGeneratorType

protected String getGeneratorType()

Specified by:

getGeneratorType in class AbstractModelloGeneratorMojo

producesCompilableResult

protected boolean producesCompilableResult()

Overrides:

producesCompilableResult in class AbstractModelloGeneratorMojo

getOutputDirectory

public File getOutputDirectory()

Specified by:

getOutputDirectory in class AbstractModelloGeneratorMojo

setOutputDirectory

public void setOutputDirectory(File outputDirectory)

customizeParameters

protected void customizeParameters(Properties parameters)

Description copied from class: AbstractModelloGeneratorMojo

Override this method to customize the values in the properties set.

This method will be called after the parameters have been populated with the parameters in the abstract mojo.

Overrides:

customizeParameters in class AbstractModelloGeneratorMojo

Parameters:

parameters - the parameters to customize

getFirstVersion

public String getFirstVersion()

setFirstVersion

public void setFirstVersion(String firstVersion)