Built by Maven

modello:xdoc

Full name:

org.codehaus.modello:modello-maven-plugin:2.4.0:xdoc

Description:

Creates documentation for the model in xdoc format.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is thread-safe and supports parallel builds.

Required Parameters

Name Type Since Description
<basedir> String - Base directory of the project, from where the Modello models are loaded.
Default: ${basedir}
<models> String[] - List of relative paths to mdo files containing the models.
<outputDirectory> File - The output directory of the generated documentation.
Default: ${project.build.directory}/generated-site/xdoc
<packageWithVersion> boolean - True if the generated package names should include the version.
Default: false
User Property: packageWithVersion
<version> String - The version of the model we will be working on.
User Property: version

Optional Parameters

Name Type Since Description
<firstVersion> String 1.0-alpha-14 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.
<licenseFile> File 2.3.1 The file that contains license header text. If both configured, the licenseText prevails.
<licenseText> String 2.3.1 The contents of license header text, verbatim.
<packagedVersions> List<String> - Additional historical versions to generate, each being packaged with the version regardless of the packageWithVersion setting.
<xdocFileName> String 1.0-alpha-21 No description.

Parameter Details

<basedir>

Base directory of the project, from where the Modello models are loaded.
  • Type: java.lang.String
  • Required: Yes
  • Default: ${basedir}

<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.
  • Type: java.lang.String
  • Since: 1.0-alpha-14
  • Required: No

<licenseFile>

The file that contains license header text. If both configured, the licenseText prevails.
  • Type: java.io.File
  • Since: 2.3.1
  • Required: No

<licenseText>

The contents of license header text, verbatim.
  • Type: java.lang.String
  • Since: 2.3.1
  • Required: No

<models>

List of relative paths to mdo files containing the models.
  • Type: java.lang.String[]
  • Required: Yes

<outputDirectory>

The output directory of the generated documentation.
  • Type: java.io.File
  • Required: Yes
  • Default: ${project.build.directory}/generated-site/xdoc

<packageWithVersion>

True if the generated package names should include the version.
  • Type: boolean
  • Required: Yes
  • User Property: packageWithVersion
  • Default: false

<packagedVersions>

Additional historical versions to generate, each being packaged with the version regardless of the packageWithVersion setting.
  • Type: java.util.List<java.lang.String>
  • Required: No

<version>

The version of the model we will be working on.
  • Type: java.lang.String
  • Required: Yes
  • User Property: version

<xdocFileName>

No description.
  • Type: java.lang.String
  • Since: 1.0-alpha-21
  • Required: No