plugin:xdoc

Full name:

org.apache.maven.plugins:maven-plugin-plugin:2.5.1:xdoc

Description:

Generate Xdoc files for the project mojos or goals.

Attributes:

  • Requires a Maven 2.0 project to be executed.
  • Since version: 2.0.

Optional Parameters

Name Type Since Description
encoding String 2.5 The file encoding of the source files.
Default value is: ${project.build.sourceEncoding}.
extractors Set 2.0 The role names of mojo extractors to use.

If not set, all mojo extractors will be used. If set to an empty extractor name, no mojo extractors will be used.

Example: 

<!-- Use all mojo extractors -->
<extractors/>

<!-- Use no mojo extractors -->
<extractors>
<extractor/>
</extractors>

<!-- Use only bsh mojo extractor -->
<extractors>
<extractor>bsh</extractor>
</extractors>

goalPrefix String 2.0 The goal prefix that will appear before the ":".
outputDirectory File 2.0 The directory where the generated Xdoc files will be put.
Default value is: ${project.build.directory}/generated-site/xdoc.

Parameter Details

encoding:

The file encoding of the source files.
  • Type: java.lang.String
  • Since: 2.5
  • Required: No
  • Expression: ${encoding}
  • Default: ${project.build.sourceEncoding}

extractors:

The role names of mojo extractors to use.

If not set, all mojo extractors will be used. If set to an empty extractor name, no mojo extractors will be used.

Example: 

<!-- Use all mojo extractors -->
<extractors/>

<!-- Use no mojo extractors -->
<extractors>
<extractor/>
</extractors>

<!-- Use only bsh mojo extractor -->
<extractors>
<extractor>bsh</extractor>
</extractors>
  • Type: java.util.Set
  • Since: 2.0
  • Required: No

goalPrefix:

The goal prefix that will appear before the ":".
  • Type: java.lang.String
  • Since: 2.0
  • Required: No

outputDirectory:

The directory where the generated Xdoc files will be put.
  • Type: java.io.File
  • Since: 2.0
  • Required: No
  • Default: ${project.build.directory}/generated-site/xdoc