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 java.lang.String
firstVersion
The first version of the model.private java.io.File
outputDirectory
The output directory of the generated documentation.private java.lang.String
xdocFileName
-
Constructor Summary
Constructors Constructor Description ModelloXdocMojo()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
customizeParameters(java.util.Properties parameters)
Override this method to customize the values in the properties set.java.lang.String
getFirstVersion()
protected java.lang.String
getGeneratorType()
java.io.File
getOutputDirectory()
protected boolean
producesCompilableResult()
void
setFirstVersion(java.lang.String firstVersion)
void
setOutputDirectory(java.io.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
-
-
-
-
Field Detail
-
outputDirectory
@Parameter(defaultValue="${project.build.directory}/generated-site/xdoc", required=true) private java.io.File outputDirectory
The output directory of the generated documentation.
-
xdocFileName
@Parameter private java.lang.String xdocFileName
- Since:
- 1.0-alpha-21
-
firstVersion
@Parameter private java.lang.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
-
-
Method Detail
-
getGeneratorType
protected java.lang.String getGeneratorType()
- Specified by:
getGeneratorType
in classAbstractModelloGeneratorMojo
-
producesCompilableResult
protected boolean producesCompilableResult()
- Overrides:
producesCompilableResult
in classAbstractModelloGeneratorMojo
-
getOutputDirectory
public java.io.File getOutputDirectory()
- Specified by:
getOutputDirectory
in classAbstractModelloGeneratorMojo
-
setOutputDirectory
public void setOutputDirectory(java.io.File outputDirectory)
-
customizeParameters
protected void customizeParameters(java.util.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 classAbstractModelloGeneratorMojo
- Parameters:
parameters
- the parameters to customize
-
getFirstVersion
public java.lang.String getFirstVersion()
-
setFirstVersion
public void setFirstVersion(java.lang.String firstVersion)
-
-