plugin:xdoc

Full name:

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

Description:

Generate Xdoc files for the project mojos or goals.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is thread-safe and supports parallel builds.
  • 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}.
User property is: encoding.
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.
packagingTypes List 3.3 Maven plugin packaging types. Default is single "maven-plugin".
skip boolean 2.8 Set this to "true" to skip invoking any goals or reports of the plugin.
Default value is: false.
User property is: maven.plugin.skip.
skipErrorNoDescriptorsFound boolean 3.0 By default an exception is throw if no mojo descriptor is found. As the maven-plugin is defined in core, the descriptor generator mojo is bound to generate-resources phase. But for annotations, the compiled classes are needed, so skip error
Default value is: false.
User property is: maven.plugin.skipErrorNoDescriptorsFound.

Parameter Details

encoding:

The file encoding of the source files.
  • Type: java.lang.String
  • Since: 2.5
  • Required: No
  • User Property: 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

packagingTypes:

Maven plugin packaging types. Default is single "maven-plugin".
  • Type: java.util.List
  • Since: 3.3
  • Required: No

skip:

Set this to "true" to skip invoking any goals or reports of the plugin.
  • Type: boolean
  • Since: 2.8
  • Required: No
  • User Property: maven.plugin.skip
  • Default: false

skipErrorNoDescriptorsFound:

By default an exception is throw if no mojo descriptor is found. As the maven-plugin is defined in core, the descriptor generator mojo is bound to generate-resources phase. But for annotations, the compiled classes are needed, so skip error
  • Type: boolean
  • Since: 3.0
  • Required: No
  • User Property: maven.plugin.skipErrorNoDescriptorsFound
  • Default: false